Skip to main content
POST
/
v1
/
playbooks
Create playbook
curl --request POST \
  --url https://api.devin.ai/v1/playbooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "body": "<string>",
  "macro": "<string>"
}'
{
  "playbook_id": "<string>",
  "title": "<string>",
  "body": "<string>",
  "status": "<string>",
  "access_type": "<string>",
  "org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_user_name": "<string>",
  "updated_by_user_id": "<string>",
  "updated_by_user_name": "<string>",
  "macro": "<string>"
}
Create a new team playbook. Requires ManageOrgPlaybooks permission.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating or updating a playbook

​
title
string
required

The title of the playbook

Minimum length: 1
​
body
string
required

The content/instructions of the playbook

Minimum length: 1
​
macro
string | null

Optional macro shortcut for the playbook (e.g., !deploy)

Response

Playbook created successfully

Response object for playbook operations

​
playbook_id
string

Unique identifier for the playbook

​
title
string

The title of the playbook

​
body
string

The content/instructions of the playbook

​
status
string

Status of the playbook (published, deleted, etc.)

​
access_type
string

Access level of the playbook (team, community, etc.)

​
org_id
string

Organization ID that owns the playbook

​
created_at
string<date-time>

When the playbook was created

​
updated_at
string<date-time>

When the playbook was last updated

​
created_by_user_id
string | null

ID of the user who created the playbook

​
created_by_user_name
string | null

Name of the user who created the playbook

​
updated_by_user_id
string | null

ID of the user who last updated the playbook

​
updated_by_user_name
string | null

Name of the user who last updated the playbook

​
macro
string | null

Optional macro shortcut for the playbook