Skip to main content
POST
Criar nova sessão

Autorizações

Authorization
string
header
obrigatório

Chave de API pessoal (apk_user_*) ou chave de API de serviço (apk_*)

Corpo

application/json
prompt
string
obrigatório
idempotent
boolean
padrão:false
knowledge_ids
string[] | null

Lista de IDs de Knowledge a serem usados. Se for None, use todo o Knowledge. Se for uma lista vazia, não use nenhum Knowledge.

max_acu_limit
integer | null

Limite máximo de ACU; deve ser um valor positivo

Intervalo obrigatório: x > 0
playbook_id
string | null
secret_ids
string[] | null

Lista de IDs de segredos a utilizar. Se for None, use todos os segredos. Se for uma lista vazia, não use nenhum segredo.

session_secrets
SessionSecretInput · object[] | null

Lista de segredos específicos da sessão para uso. Esses segredos ficam disponíveis apenas nesta sessão e não são armazenados nos segredos da organização.

snapshot_id
string | null
structured_output_schema
Structured Output Schema · object | null

JSON Schema (Draft 7) para validar saídas estruturadas. Máx. 64 KB. Deve ser autocontido (sem $ref externo).

tags
string[] | null

Lista de tags a serem adicionadas à sessão.

Maximum array length: 50
title
string | null

Título personalizado para a sessão. Se for None, um título será gerado automaticamente.

unlisted
boolean
padrão:false

Resposta

Resposta bem-sucedida

Corpo da resposta retornado quando uma sessão é criada com sucesso.

session_id
string
obrigatório
url
string
obrigatório
is_new_session
boolean | null