Pular para o conteúdo principal
POST
Criar sessão

Permissões

Requer um usuário de serviço ou token de acesso pessoal com a permissão UseDevinSessions (org.devins.use) no nível da organização.

Permissões adicionais para recursos avançados

Modo Devin

O parâmetro devin_mode controla qual modo do agente Devin é usado na sessão: Quando omitido, a sessão usa o modo padrão da organização. Os modos em prévia estão sujeitos às mesmas restrições de feature flag e de prévia do agente no Enterprise que o app web.

Impersonação de usuário

O parâmetro create_as_user_id permite criar uma sessão em nome de outro usuário. Para isso, é necessário que:
  1. O usuário de serviço tenha a permissão ImpersonateOrgSessions
  2. O usuário de destino seja membro da organização
  3. O usuário de destino tenha a permissão UseDevinSessions

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

org_id
string | null
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Parâmetros de consulta

devin_id
string | null

Corpo

application/json
prompt
string
obrigatório
title
string | null
tags
string[] | null
max_acu_limit
integer | null
playbook_id
string | null
knowledge_ids
string[] | null
secret_ids
string[] | null
session_secrets
SessionSecretInput · object[] | null
repos
string[] | null
attachment_urls
string<uri>[] | null
Required string length: 1 - 2083
create_as_user_id
string | null
child_playbook_id
string | null
bypass_approval
boolean | null
security_profile
SessionSecurityProfileSelection · object | null

Associe um perfil de segurança a esta sessão; se omitido, aplica-se a regra padrão de resolução (o perfil de segurança associado ao playbook, se houver; caso contrário, o padrão da organização/Enterprise). Requer a permissão de gerenciamento de perfis de segurança.

structured_output_schema
Structured Output Schema · object | null

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

structured_output_required
boolean | null

Quando true (padrão), o Agent DEVE chamar provide_structured_output com is_final=true antes do fim do turno. Quando false, a ferramenta está disponível, mas não é obrigatória — não há garantia de que será chamada em um determinado turno.

resumable
boolean
padrão:true

Se o estado da VM da sessão deve ser preservado após ela ser encerrada, para que a sessão possa ser retomada. Defina como false para sessões descartáveis.

memory_enabled
boolean | null

Defina como false para manter a memória desativada nesta sessão e em suas sessões filhas: a sessão não lê nem grava memória, e a memória não aprende com a transcrição da sessão. Omita o campo ou defina-o como true para seguir as configurações de memória do proprietário; true não ativa a memória se essas configurações a mantiverem desativada.

platform
string | null

Substitui a plataforma da VM da sessão (p. ex., 'windows') ou o nome de um pool do outpost (BYOB) para executar a sessão em uma das suas próprias máquinas. Quando omitido (ou definido como 'inherit'), uma sessão criada por um Devin pai herda o posicionamento do pai — tanto a plataforma quanto o pool do outpost; assim, um pai alocado em um outpost gera filhos no mesmo pool; caso contrário, usa-se o padrão da organização. Qualquer valor deve corresponder a uma plataforma configurada para a sua organização ou a um nome de pool do outpost (sem diferenciar maiúsculas de minúsculas) — plataformas nativas têm prioridade quando um nome corresponde a ambos, e um pool do outpost pessoal pertencente ao chamador tem prioridade sobre um pool no nível da conta com o mesmo nome. Valores não reconhecidos são rejeitados com um erro 400 cujo corpo lista os rótulos de plataforma disponíveis e os nomes de pool do outpost da org.

devin_mode
enum<string> | null

Substitui o modo Agent do Devin para a sessão. 'normal' usa o modo Agent padrão, 'fast' usa o modo Fast, 'lite' usa Devin Lite, 'ultra' usa Devin Ultra e 'fusion' usa Fusion. Os demais valores selecionam o modo do agente com o mesmo nome no web app. Os modos de prévia estão sujeitos à mesma feature flag e às mesmas restrições de prévia do agente no Enterprise que o web app.

Opções disponíveis:
normal,
fast,
fusion,
lite,
ultra,
fast-ultra,
swe-2-medium,
swe-2-high,
swe-2-max

Resposta

Resposta bem-sucedida

session_id
string
obrigatório
url
string
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
new,
claimed,
running,
exit,
error,
suspended,
resuming
tags
string[]
obrigatório
org_id
string | null
obrigatório

Organização proprietária. Null para sessões desvinculadas, que pertencem à conta de seu criador, e não a uma organização.

created_at
integer
obrigatório
updated_at
integer
obrigatório
acus_consumed
number
obrigatório
pull_requests
SessionPullRequest · object[]
obrigatório
title
string | null
playbook_id
string | null
user_id
string | null
is_archived
boolean
padrão:false
parent_session_id
string | null
child_session_ids
string[] | null
service_user_id
string | null
category
enum<string> | null

A categoria de caso de uso atribuída à sessão, se a categorização tiver sido executada. Preenchido apenas nos endpoints get/list.

Opções disponíveis:
bug_fixing,
ci_cd_and_devops,
code_quality_and_security,
code_review,
code_review_and_analysis,
data_and_automation,
documentation_and_content,
feature_development,
migrations_and_upgrades,
other,
production_investigation,
refactoring_and_optimization,
research_and_exploration,
security,
unit_test_generation
subcategory
string | null

O nome de exibição da subcategoria atribuída à sessão. 'Other' quando uma categoria está definida, mas nenhuma subcategoria foi atribuída ou resolvida. Preenchido apenas nos endpoints get/list.

origin
enum<string> | null

A origem em que a sessão foi criada.

Opções disponíveis:
webapp,
slack,
teams,
api,
linear,
jira,
automation,
cli,
desktop,
code_scan,
other
automation_id
string | null

ID da automação que criou esta sessão, se houver.

structured_output
Structured Output · object | null

Saída estruturada validada da sessão. Preenchido apenas nos endpoints get/list.

devin_mode
enum<string> | null

O modo Agent do Devin com o qual a sessão foi criada, após aplicar os padrões da organização/do usuário e a herança da sessão pai. Nenhum quando a sessão executa uma prévia do agente que não tem um modo equivalente.

Opções disponíveis:
normal,
fast,
fusion,
lite,
ultra,
fast-ultra,
swe-2-medium,
swe-2-high,
swe-2-max
status_detail
enum<string> | null

Detalhe adicional sobre o status atual da sessão. Quando o status é 'running': 'working' (trabalhando ativamente), 'waiting_for_user' (precisa de entrada do usuário), 'waiting_for_approval' (aguardando aprovação de ação no modo seguro) ou 'finished' (tarefa concluída). Quando o status é 'suspended': o motivo da suspensão, como 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'user_usage_limit_exceeded', 'total_session_limit_exceeded', 'contract_expired' ou 'error'. Preenchido apenas nos endpoints get/list.

Opções disponíveis:
working,
waiting_for_user,
waiting_for_approval,
finished,
inactivity,
user_request,
usage_limit_exceeded,
out_of_credits,
out_of_quota,
no_quota_allocation,
payment_declined,
org_usage_limit_exceeded,
user_usage_limit_exceeded,
total_session_limit_exceeded,
contract_expired,
error
on_demand_usage
number | null

Gasto sob demanda (excedente) em USD nesta sessão, excluindo sessões filhas. Preenchido apenas para planos Teams; 0 quando a sessão foi totalmente coberta pela cota. Omitido para outros planos. Preenchido apenas nos endpoints get/list.

security_profile
SessionSecurityProfileResponse · object | null

A vinculação da própria sessão a um perfil de segurança. Preenchido apenas nos endpoints get/list.