Skip to navigation
API ReferenceV1

Create a new session

Create a new Devin session with the specified prompt and configuration options.

Authentication

AuthorizationBearer

Personal API Key (apk_user_) or Service API Key (apk_)

Request

This endpoint expects an object.
promptstringRequired
idempotentbooleanOptionalDefaults to false
knowledge_idslist of strings or nullOptional
List of knowledge IDs to use. If None, use all knowledge. If empty list, use no knowledge.
max_acu_limitinteger or nullOptional
Maximum ACU limit, must be positive
playbook_idstring or nullOptional
secret_idslist of strings or nullOptional
List of secret IDs to use. If None, use all secrets. If empty list, use no secrets.
session_secretslist of objects or nullOptional

List of session-specific secrets to use. These secrets are only available in this session and are not stored in organization secrets.

snapshot_idstring or nullOptional
structured_output_schemamap from strings to any or nullOptional

JSON Schema (Draft 7) for validating structured output. Max 64KB. Must be self-contained (no external $ref).

tagslist of strings or nullOptional
List of tags to add to the session.
titlestring or nullOptional
Custom title for the session. If None, a title will be generated automatically.
unlistedbooleanOptionalDefaults to false

Response

Successful Response
session_idstring
urlstring
is_new_sessionboolean or nullOptional

Errors

422
Unprocessable Entity Error