Create Session

Create a new session

POST /v3/organizations/{org_id}/sessions

Create Session

cURL

curl --request POST \
  --url https://api.devin.ai/v3/organizations/{org_id}/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "attachment_urls": [
    "<string>"
  ],
  "bypass_approval": true,
  "child_playbook_id": "<string>",
  "create_as_user_id": "<string>",
  "knowledge_ids": [
    "<string>"
  ],
  "max_acu_limit": 123,
  "platform": "<string>",
  "playbook_id": "<string>",
  "repos": [
    "<string>"
  ],
  "resumable": true,
  "secret_ids": [
    "<string>"
  ],
  "session_links": [
    "<string>"
  ],
  "session_secrets": [
    {
      "key": "<string>",
      "value": "<string>",
      "sensitive": true
    }
  ],
  "structured_output_required": true,
  "structured_output_schema": {},
  "tags": [
    "<string>"
  ],
  "title": "<string>"
}
'

import requests

url = "https://api.devin.ai/v3/organizations/{org_id}/sessions"

payload = {
    "prompt": "<string>",
    "attachment_urls": ["<string>"],
    "bypass_approval": True,
    "child_playbook_id": "<string>",
    "create_as_user_id": "<string>",
    "knowledge_ids": ["<string>"],
    "max_acu_limit": 123,
    "platform": "<string>",
    "playbook_id": "<string>",
    "repos": ["<string>"],
    "resumable": True,
    "secret_ids": ["<string>"],
    "session_links": ["<string>"],
    "session_secrets": [
        {
            "key": "<string>",
            "value": "<string>",
            "sensitive": True
        }
    ],
    "structured_output_required": True,
    "structured_output_schema": {},
    "tags": ["<string>"],
    "title": "<string>"
}
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>',
    attachment_urls: ['<string>'],
    bypass_approval: true,
    child_playbook_id: '<string>',
    create_as_user_id: '<string>',
    knowledge_ids: ['<string>'],
    max_acu_limit: 123,
    platform: '<string>',
    playbook_id: '<string>',
    repos: ['<string>'],
    resumable: true,
    secret_ids: ['<string>'],
    session_links: ['<string>'],
    session_secrets: [{key: '<string>', value: '<string>', sensitive: true}],
    structured_output_required: true,
    structured_output_schema: {},
    tags: ['<string>'],
    title: '<string>'
  })
};

fetch('https://api.devin.ai/v3/organizations/{org_id}/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/v3/organizations/{org_id}/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>',
    'attachment_urls' => [
        '<string>'
    ],
    'bypass_approval' => true,
    'child_playbook_id' => '<string>',
    'create_as_user_id' => '<string>',
    'knowledge_ids' => [
        '<string>'
    ],
    'max_acu_limit' => 123,
    'platform' => '<string>',
    'playbook_id' => '<string>',
    'repos' => [
        '<string>'
    ],
    'resumable' => true,
    'secret_ids' => [
        '<string>'
    ],
    'session_links' => [
        '<string>'
    ],
    'session_secrets' => [
        [
                'key' => '<string>',
                'value' => '<string>',
                'sensitive' => true
        ]
    ],
    'structured_output_required' => true,
    'structured_output_schema' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'title' => '<string>'
  ]),
  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/v3/organizations/{org_id}/sessions"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"attachment_urls\": [\n    \"<string>\"\n  ],\n  \"bypass_approval\": true,\n  \"child_playbook_id\": \"<string>\",\n  \"create_as_user_id\": \"<string>\",\n  \"knowledge_ids\": [\n    \"<string>\"\n  ],\n  \"max_acu_limit\": 123,\n  \"platform\": \"<string>\",\n  \"playbook_id\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"resumable\": true,\n  \"secret_ids\": [\n    \"<string>\"\n  ],\n  \"session_links\": [\n    \"<string>\"\n  ],\n  \"session_secrets\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"sensitive\": true\n    }\n  ],\n  \"structured_output_required\": true,\n  \"structured_output_schema\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\"\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/v3/organizations/{org_id}/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"attachment_urls\": [\n    \"<string>\"\n  ],\n  \"bypass_approval\": true,\n  \"child_playbook_id\": \"<string>\",\n  \"create_as_user_id\": \"<string>\",\n  \"knowledge_ids\": [\n    \"<string>\"\n  ],\n  \"max_acu_limit\": 123,\n  \"platform\": \"<string>\",\n  \"playbook_id\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"resumable\": true,\n  \"secret_ids\": [\n    \"<string>\"\n  ],\n  \"session_links\": [\n    \"<string>\"\n  ],\n  \"session_secrets\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"sensitive\": true\n    }\n  ],\n  \"structured_output_required\": true,\n  \"structured_output_schema\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3/organizations/{org_id}/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  \"attachment_urls\": [\n    \"<string>\"\n  ],\n  \"bypass_approval\": true,\n  \"child_playbook_id\": \"<string>\",\n  \"create_as_user_id\": \"<string>\",\n  \"knowledge_ids\": [\n    \"<string>\"\n  ],\n  \"max_acu_limit\": 123,\n  \"platform\": \"<string>\",\n  \"playbook_id\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"resumable\": true,\n  \"secret_ids\": [\n    \"<string>\"\n  ],\n  \"session_links\": [\n    \"<string>\"\n  ],\n  \"session_secrets\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"sensitive\": true\n    }\n  ],\n  \"structured_output_required\": true,\n  \"structured_output_schema\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "acus_consumed": 123,
  "created_at": 123,
  "org_id": "<string>",
  "pull_requests": [
    {
      "pr_state": "<string>",
      "pr_url": "<string>"
    }
  ],
  "session_id": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": 123,
  "url": "<string>",
  "child_session_ids": [
    "<string>"
  ],
  "is_archived": false,
  "parent_session_id": "<string>",
  "playbook_id": "<string>",
  "service_user_id": "<string>",
  "structured_output": {},
  "subcategory": "<string>",
  "title": "<string>",
  "user_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

Permissions

Requires a service user with the ManageOrgSessions permission at the organization level.

Additional permissions for advanced features

Feature	Required Permission
create_as_user_id	ImpersonateOrgSessions

Devin mode

The devin_mode parameter controls which Devin agent mode is used for the session:

Mode	Description
normal	The default agent mode. Fast and good at long-horizon planning.
fast	~2x faster, 4x more expensive, same intelligence.

When omitted, the session uses the organization’s default mode. Fast mode is subject to the same feature flag and enterprise agent preview restrictions as the web app.

User impersonation

The create_as_user_id parameter allows creating a session on behalf of another user. This requires:

1. The service user must have ImpersonateOrgSessions permission
2. The target user must be a member of the organization
3. The target user must have UseDevinSessions permission

Authorizations

Authorization · string · header · required

Service User credential (prefix: cog_)

Path Parameters

org_id · string | null · required

Organization ID (prefix: org-)

Example:

"org-abc123def456"

Query Parameters

devin_id · string | null

Body

application/json

prompt · string · required

attachment_urls · string<uri>[] | null

Required string length: 1 - 2083

bypass_approval · boolean | null

child_playbook_id · string | null

create_as_user_id · string | null

devin_mode · enum<string> | null

Override the Devin agent mode for the session. 'normal' uses the default Agent mode, 'fast' uses Fast mode, 'lite' uses Devin Lite, 'ultra' uses Devin Ultra, and 'fusion' uses Fusion. Preview modes are subject to the same feature flag and enterprise agent preview restrictions as the web app.

Available options: normal, fast, lite, ultra, fusion

knowledge_ids · string[] | null

max_acu_limit · integer | null

platform · string | null

Override the VM platform for the session (e.g. 'windows'), or the name of an outpost (BYOB) pool to run the session on one of your own machines. When omitted (or set to 'inherit'), a session created by a parent Devin inherits the parent's placement — both its platform and its outpost pool, so an outpost-placed parent spawns children on the same pool; otherwise the organization default is used. Any value must match either a platform configured for your organization or an outpost pool name (case-insensitive) — built-in platforms take priority when a name matches both. Unrecognized values are rejected with a 400 whose error body lists the available platform labels and outpost pool names for the org.

playbook_id · string | null

repos · string[] | null

resumable · boolean · default: true

Whether to preserve the session's VM state after it stops so the session can be resumed. Set to false for disposable sessions.

secret_ids · string[] | null

session_links · string[] | null

session_secrets · SessionSecretInput · object[] | null

Show child attributes

structured_output_required · boolean | null

When true (default), the agent MUST call provide_structured_output with is_final=true before its turn ends. When false, the tool is available but not required — it is not guaranteed to be called in a given turn.

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

title · string | null

Response

200

application/json

Successful Response

acus_consumed · number · required

created_at · integer · required

org_id · string · required

pull_requests · SessionPullRequest · object[] · required

Show child attributes

session_id · string · required

status · enum<string> · required

Available options: new, claimed, running, exit, error, suspended, resuming

tags · string[] · required

updated_at · integer · required

url · string · required

category · enum<string> | null

The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints.

Available options: 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

child_session_ids · string[] | null

is_archived · boolean · default: false

origin · enum<string> | null

The origin from which the session was created.

Available options: webapp, slack, teams, api, linear, jira, automation, cli, desktop, code_scan, other

parent_session_id · string | null

playbook_id · string | null

service_user_id · string | null

status_detail · enum<string> | null

Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'total_session_limit_exceeded', or 'error'. Only populated on get/list endpoints.

Available options: 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, total_session_limit_exceeded, error

structured_output · Structured Output · object | null

Validated structured output from the session. Only populated on get/list endpoints.

subcategory · string | null

The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints.

title · string | null

user_id · string | null