Salas

GET`/v1/rooms`

Listar salas

Permissão: rooms:read

Parâmetros

Nome	Tipo	Descrição
`limit`	`query · integer`

Resposta `200`

Nome	Tipo	Descrição
`data` obrigatório	`object[]`
`data[].id` obrigatório	`string`
`data[].url` obrigatório	`string`
`data[].title` obrigatório	`string`
`data[].visibility` obrigatório	`"private" \| "public"`
`data[].status` obrigatório	`"scheduled" \| "live" \| "ended"`
`data[].created_at` obrigatório	`string`
`data[].expires_at` obrigatório	`string`
`data[].starts_at` obrigatório	`string \| null`
`data[].duration_min` obrigatório	`integer \| null`
`data[].invitees` obrigatório	`string[]`
`data[].langs` obrigatório	`string[]`
`data[].livemode` obrigatório	`boolean`	false for objects created with a kt_test_ key (simulator).

Exemplo

curl

curl "https://api.kanutus.com/v1/rooms" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/rooms", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "GET",
    "https://api.kanutus.com/v1/rooms",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API limit query

GET /v1/rooms

Respostas por status

200 Rooms, newest first

200

{
  "data": [
    {
      "id": "kqz-mbdt-wpa",
      "url": "https://example.com",
      "title": "string",
      "visibility": "private",
      "status": "scheduled",
      "created_at": "string",
      "expires_at": "string",
      "starts_at": "string",
      "duration_min": 0,
      "invitees": [
        "string"
      ],
      "langs": [
        "string"
      ],
      "livemode": true
    }
  ]
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

POST`/v1/rooms`

Criar uma sala instantânea

Permissão: rooms:write

Parâmetros

Nome	Tipo	Descrição
`idempotency-key` obrigatório	`header · string`	Unique key per create request; retries with the same key return the same result.

Corpo da requisição

Nome	Tipo	Descrição
`title`	`string`	length 0–120 · default ""
`visibility`	`"private" \| "public"`	default "private"
`langs`	`string[]`	Languages expected in the room (helps warm-up).

Resposta `201`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`url` obrigatório	`string`
`title` obrigatório	`string`
`visibility` obrigatório	`"private" \| "public"`
`status` obrigatório	`"scheduled" \| "live" \| "ended"`
`created_at` obrigatório	`string`
`expires_at` obrigatório	`string`
`starts_at` obrigatório	`string \| null`
`duration_min` obrigatório	`integer \| null`
`invitees` obrigatório	`string[]`
`langs` obrigatório	`string[]`
`livemode` obrigatório	`boolean`	false for objects created with a kt_test_ key (simulator).

Exemplo

curl

curl -X POST "https://api.kanutus.com/v1/rooms" \
  -H "Authorization: Bearer $KANUTUS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Proposta com a Andes","visibility":"private","langs":[]}'

Node.js

const res = await fetch("https://api.kanutus.com/v1/rooms", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"title":"Proposta com a Andes","visibility":"private","langs":[]}),
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "POST",
    "https://api.kanutus.com/v1/rooms",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={"title":"Proposta com a Andes","visibility":"private","langs":[]},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API Corpo da requisição (JSON)

POST /v1/rooms

Respostas por status

201 Room created (share its url)

201

{
  "id": "kqz-mbdt-wpa",
  "url": "https://example.com",
  "title": "string",
  "visibility": "private",
  "status": "scheduled",
  "created_at": "string",
  "expires_at": "string",
  "starts_at": "string",
  "duration_min": 0,
  "invitees": [
    "string"
  ],
  "langs": [
    "string"
  ],
  "livemode": true
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

409 Conflict (idempotency or state)

409 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 409,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

GET`/v1/rooms/{id}`

Ler uma sala

Permissão: rooms:read

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Resposta `200`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`url` obrigatório	`string`
`title` obrigatório	`string`
`visibility` obrigatório	`"private" \| "public"`
`status` obrigatório	`"scheduled" \| "live" \| "ended"`
`created_at` obrigatório	`string`
`expires_at` obrigatório	`string`
`starts_at` obrigatório	`string \| null`
`duration_min` obrigatório	`integer \| null`
`invitees` obrigatório	`string[]`
`langs` obrigatório	`string[]`
`livemode` obrigatório	`boolean`	false for objects created with a kt_test_ key (simulator).

Exemplo

curl

curl "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "GET",
    "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório

GET /v1/rooms/{id}

Respostas por status

200 The room

200

{
  "id": "kqz-mbdt-wpa",
  "url": "https://example.com",
  "title": "string",
  "visibility": "private",
  "status": "scheduled",
  "created_at": "string",
  "expires_at": "string",
  "starts_at": "string",
  "duration_min": 0,
  "invitees": [
    "string"
  ],
  "langs": [
    "string"
  ],
  "livemode": true
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

DELETE`/v1/rooms/{id}`

Encerrar a sala para todos

Permissão: rooms:write

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Resposta `200`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`url` obrigatório	`string`
`title` obrigatório	`string`
`visibility` obrigatório	`"private" \| "public"`
`status` obrigatório	`"scheduled" \| "live" \| "ended"`
`created_at` obrigatório	`string`
`expires_at` obrigatório	`string`
`starts_at` obrigatório	`string \| null`
`duration_min` obrigatório	`integer \| null`
`invitees` obrigatório	`string[]`
`langs` obrigatório	`string[]`
`livemode` obrigatório	`boolean`	false for objects created with a kt_test_ key (simulator).

Exemplo

curl

curl -X DELETE "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "DELETE",
    "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório

DELETE /v1/rooms/{id}

Respostas por status

200 The ended room

200

{
  "id": "kqz-mbdt-wpa",
  "url": "https://example.com",
  "title": "string",
  "visibility": "private",
  "status": "scheduled",
  "created_at": "string",
  "expires_at": "string",
  "starts_at": "string",
  "duration_min": 0,
  "invitees": [
    "string"
  ],
  "langs": [
    "string"
  ],
  "livemode": true
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

POST`/v1/rooms/{id}/join-links`

Criar link de convidado (nome e língua preenchidos)

Permissão: rooms:write

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Corpo da requisição

Nome	Tipo	Descrição
`name`	`string`	length 1–80
`speak`	`string`	Language the guest speaks (prefilled).
`hear`	`string`	Language the guest wants to hear (prefilled).

Resposta `201`

Nome	Tipo	Descrição
`url` obrigatório	`string`
`room_id` obrigatório	`string`

Exemplo

curl

curl -X POST "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa/join-links" \
  -H "Authorization: Bearer $KANUTUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Kenji","speak":"pt","hear":"pt"}'

Node.js

const res = await fetch("https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa/join-links", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name":"Kenji","speak":"pt","hear":"pt"}),
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "POST",
    "https://api.kanutus.com/v1/rooms/kqz-mbdt-wpa/join-links",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
    json={"name":"Kenji","speak":"pt","hear":"pt"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório Corpo da requisição (JSON)

POST /v1/rooms/{id}/join-links

Respostas por status

201 Link to share; opens the room directly

201

{
  "url": "https://example.com",
  "room_id": "string"
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

Salas

GET/v1/rooms#

Parâmetros

Resposta 200

Exemplo

Respostas por status

POST/v1/rooms#

Parâmetros

Corpo da requisição

Resposta 201

Exemplo

Respostas por status

GET/v1/rooms/{id}#

Parâmetros

Resposta 200

Exemplo

Respostas por status

DELETE/v1/rooms/{id}#

Parâmetros

Resposta 200

Exemplo

Respostas por status

POST/v1/rooms/{id}/join-links#

Parâmetros

Corpo da requisição

Resposta 201

Exemplo

Respostas por status

GET`/v1/rooms`

Resposta `200`

POST`/v1/rooms`

Resposta `201`

GET`/v1/rooms/{id}`

Resposta `200`

DELETE`/v1/rooms/{id}`

Resposta `200`

POST`/v1/rooms/{id}/join-links`

Resposta `201`