Skip to main content
POST
/
v1
/
sessions
Create a new session
curl --request POST \
  --url https://api.devin.ai/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "idempotent": false,
  "knowledge_ids": [
    "<string>"
  ],
  "max_acu_limit": 1,
  "playbook_id": "<string>",
  "secret_ids": [
    "<string>"
  ],
  "session_secrets": [
    {
      "key": "<string>",
      "value": "<string>",
      "sensitive": true
    }
  ],
  "snapshot_id": "<string>",
  "structured_output_schema": {},
  "tags": [
    "<string>"
  ],
  "title": "<string>",
  "unlisted": false
}
'
import requests

url = "https://api.devin.ai/v1/sessions"

payload = {
"prompt": "<string>",
"idempotent": False,
"knowledge_ids": ["<string>"],
"max_acu_limit": 1,
"playbook_id": "<string>",
"secret_ids": ["<string>"],
"session_secrets": [
{
"key": "<string>",
"value": "<string>",
"sensitive": True
}
],
"snapshot_id": "<string>",
"structured_output_schema": {},
"tags": ["<string>"],
"title": "<string>",
"unlisted": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
idempotent: false,
knowledge_ids: ['<string>'],
max_acu_limit: 1,
playbook_id: '<string>',
secret_ids: ['<string>'],
session_secrets: [{key: '<string>', value: '<string>', sensitive: true}],
snapshot_id: '<string>',
structured_output_schema: {},
tags: ['<string>'],
title: '<string>',
unlisted: false
})
};

fetch('https://api.devin.ai/v1/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.devin.ai/v1/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'idempotent' => false,
'knowledge_ids' => [
'<string>'
],
'max_acu_limit' => 1,
'playbook_id' => '<string>',
'secret_ids' => [
'<string>'
],
'session_secrets' => [
[
'key' => '<string>',
'value' => '<string>',
'sensitive' => true
]
],
'snapshot_id' => '<string>',
'structured_output_schema' => [

],
'tags' => [
'<string>'
],
'title' => '<string>',
'unlisted' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.devin.ai/v1/sessions"

payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"idempotent\": false,\n \"knowledge_ids\": [\n \"<string>\"\n ],\n \"max_acu_limit\": 1,\n \"playbook_id\": \"<string>\",\n \"secret_ids\": [\n \"<string>\"\n ],\n \"session_secrets\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": true\n }\n ],\n \"snapshot_id\": \"<string>\",\n \"structured_output_schema\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"unlisted\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.devin.ai/v1/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"idempotent\": false,\n \"knowledge_ids\": [\n \"<string>\"\n ],\n \"max_acu_limit\": 1,\n \"playbook_id\": \"<string>\",\n \"secret_ids\": [\n \"<string>\"\n ],\n \"session_secrets\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": true\n }\n ],\n \"snapshot_id\": \"<string>\",\n \"structured_output_schema\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"unlisted\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"idempotent\": false,\n \"knowledge_ids\": [\n \"<string>\"\n ],\n \"max_acu_limit\": 1,\n \"playbook_id\": \"<string>\",\n \"secret_ids\": [\n \"<string>\"\n ],\n \"session_secrets\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": true\n }\n ],\n \"snapshot_id\": \"<string>\",\n \"structured_output_schema\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"unlisted\": false\n}"

response = http.request(request)
puts response.read_body
{
  "session_id": "<string>",
  "url": "<string>",
  "is_new_session": true
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
prompt
string
required
idempotent
boolean
default:false
knowledge_ids
string[] | null

List of knowledge IDs to use. If None, use all knowledge. If empty list, use no knowledge.

max_acu_limit
integer | null

Maximum ACU limit, must be positive

Required range: x > 0
playbook_id
string | null
secret_ids
string[] | null

List of secret IDs to use. If None, use all secrets. If empty list, use no secrets.

session_secrets
SessionSecretInput · object[] | null

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

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

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

tags
string[] | null

List of tags to add to the session.

Maximum array length: 50
title
string | null

Custom title for the session. If None, a title will be generated automatically.

unlisted
boolean
default:false

Response

Successful Response

Response body returned when a session is successfully created.

session_id
string
required
url
string
required
is_new_session
boolean | null