Devin

App · 25 actions

Create and manage Devin sessions, messages, insights, playbooks and knowledge notes with the organization API.

Actions

ActionWhat it does
Append session tagsAppend tags to a session (deduplicating with existing tags).
Archive sessionArchive session and put it to sleep if currently running
Create knowledge noteCreate a note for an organization.
Create playbookCreate a playbook for an organization.
Create sessionCreate a new session This can consume paid usage.
Delete knowledge noteDelete a note for an organization.
Delete playbookDelete a playbook for an organization.
Generate session insightsTrigger on-demand generation of session insights.
Get knowledge foldersReturn the full folder tree with per-folder note counts.
Get knowledge noteGet a note by ID for an organization.
Get playbookGet a specific organization- or enterprise-level playbook.
Get sessionGet details of a specific session.
Get session insightsGet detailed insights for a specific session, including message counts, session size classification, and AI-generated analysis.
Get session tagsGet the tags for a specific session.
List knowledge notesList notes for an organization.
List playbooksList playbooks for an organization.
List session attachmentsList all attachments for a session.
List session messagesList all messages for a session with cursor-based pagination, ordered chronologically.
List sessionsList sessions.
List sessions with insightsList sessions with detailed insights including message counts, session size classification, and AI-generated analysis.
Replace session tagsReplace all tags on a session.
Send session messageSend a message to an active session.
Terminate sessionTerminate session
Update knowledge noteUpdate a note for an organization.
Update playbookUpdate a playbook for an organization.

Append session tags

Append tags to a session (deduplicating with existing tags).

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)
TagstagslistRequired
Tags.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "tags": []
  },
  "has_more": false,
  "next_cursor": null
}

Archive session

Archive session and put it to sleep if currently running

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Create knowledge note

Create a note for an organization.

Inputs

BodybodytextRequired
Body.
Folder IDfolder_idtext
Folder id.
Is enabledis_enabledtrue/false
Is enabled.
NamenametextRequired
Name.
Pinned repopinned_repotext
Pinned repo.
TriggertriggertextRequired
Trigger.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "folder_id": null,
    "folder_path": "example",
    "is_enabled": false,
    "macro": null,
    "name": "example",
    "note_id": "example",
    "org_id": null,
    "pinned_repo": null,
    "trigger": "example",
    "updated_at": 0
  },
  "has_more": false,
  "next_cursor": null
}

Create playbook

Create a playbook for an organization.

Inputs

BodybodytextRequired
Body.
Macromacrotext
Playbook macro identifier. Must start with '!' followed by one or more letters, digits, underscores, or hyphens. Example: '!my_macro' or '!my-macro'
Structured output schemastructured_output_schemaobject
JSON Schema (Draft 7) that sessions using this playbook will produce as structured output. Max 64KB. Must be self-contained (no external $ref).
TitletitletextRequired
Title.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "created_by": "example",
    "macro": null,
    "org_id": null,
    "playbook_id": "example",
    "structured_output_schema": null,
    "title": "example",
    "updated_at": 0,
    "updated_by": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Create session

Create a new session This can consume paid usage.

Inputs

Sessionsession_idtext
Session id.
Attachment URLSattachment_urlslist
Attachment urls.
Bypass approvalbypass_approvaltrue/false
Bypass approval.
Child playbook IDchild_playbook_idtext
Child playbook id.
Create as user IDcreate_as_user_idtext
Create as user id.
Devin modedevin_modetext
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. The other values select the agent mode of the same name in the web app. Preview modes are subject to the same feature flag and enterprise agent preview restrictions as the web app.One of: normal, fast, fusion, lite, ultra, swe-2-medium, swe-2-high, swe-2-max.
Knowledge IDSknowledge_idslist
Knowledge ids.
Max acu limitmax_acu_limitnumber
Max acu limit.At least 1.
Platformplatformtext
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, and a personal outpost pool owned by the caller takes priority over an accoun
Playbookplaybook_idtext
Playbook id.
PromptprompttextRequired
Prompt.
Reposreposlist
Repos.
Resumableresumabletrue/false
Whether to preserve the session's VM state after it stops so the session can be resumed. Set to false for disposable sessions.
Secret IDSsecret_idslist
Secret ids.
Security profilesecurity_profileobject
Attach a security profile to this session; omitted = default resolution applies (the playbook's security profile when one is bound, then the org/enterprise default). Requires the security-profile management permission.
Session linkssession_linkslist
Session links.
Session secretssession_secretslist
Session secrets.
Structured output requiredstructured_output_requiredtrue/false
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 schemastructured_output_schemaobject
JSON Schema (Draft 7) for validating structured output. Max 64KB. Must be self-contained (no external $ref).
Tagstagslist
Tags.
Titletitletext
Title.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Delete knowledge note

Delete a note for an organization.

Inputs

Notenote_idtextRequired
Knowledge note ID (prefix: note-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "folder_id": null,
    "folder_path": "example",
    "is_enabled": false,
    "macro": null,
    "name": "example",
    "note_id": "example",
    "org_id": null,
    "pinned_repo": null,
    "trigger": "example",
    "updated_at": 0
  },
  "has_more": false,
  "next_cursor": null
}

Delete playbook

Delete a playbook for an organization.

Inputs

Playbookplaybook_idtextRequired
Playbook ID (prefix: playbook-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "created_by": "example",
    "macro": null,
    "org_id": null,
    "playbook_id": "example",
    "structured_output_schema": null,
    "title": "example",
    "updated_at": 0,
    "updated_by": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Generate session insights

Trigger on-demand generation of session insights. This can consume paid usage.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "session_id": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get knowledge folders

Return the full folder tree with per-folder note counts.

Inputs

None.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "folders": [],
    "root_note_count": 0
  },
  "has_more": false,
  "next_cursor": null
}

Get knowledge note

Get a note by ID for an organization.

Inputs

Notenote_idtextRequired
Knowledge note ID (prefix: note-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "folder_id": null,
    "folder_path": "example",
    "is_enabled": false,
    "macro": null,
    "name": "example",
    "note_id": "example",
    "org_id": null,
    "pinned_repo": null,
    "trigger": "example",
    "updated_at": 0
  },
  "has_more": false,
  "next_cursor": null
}

Get playbook

Get a specific organization- or enterprise-level playbook.

Inputs

Playbookplaybook_idtextRequired
Playbook ID (prefix: playbook-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "created_by": "example",
    "macro": null,
    "org_id": null,
    "playbook_id": "example",
    "structured_output_schema": null,
    "title": "example",
    "updated_at": 0,
    "updated_by": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get session

Get details of a specific session.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Get session insights

Get detailed insights for a specific session, including message counts, session size classification, and AI-generated analysis.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "analysis": null,
    "analysis_status": null,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "num_devin_messages": 0,
    "num_user_messages": 0,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "session_size": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Get session tags

Get the tags for a specific session.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "tags": []
  },
  "has_more": false,
  "next_cursor": null
}

List knowledge notes

List notes for an organization. Gets one page; to see more, run it again with the next page it gives.

Inputs

Afteraftertext
After.
Firstfirstnumber
First.From 1 to 200.
Searchsearchtext
Search.
Folder pathfolder_pathtext
Folder path.
Pinned repopinned_repotext
Pinned repo.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "end_cursor": null,
    "has_next_page": false,
    "items": [],
    "total": null
  },
  "has_more": false,
  "next_cursor": null
}

List playbooks

List playbooks for an organization. Gets one page; to see more, run it again with the next page it gives.

Inputs

Afteraftertext
After.
Firstfirstnumber
First.From 1 to 200.
Include enterpriseinclude_enterprisetrue/false
Also return the enterprise-level playbooks shared with this organization (`access_type: enterprise`). They are read-only through the organization API.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "end_cursor": null,
    "has_next_page": false,
    "items": [],
    "total": null
  },
  "has_more": false,
  "next_cursor": null
}

List session attachments

List all attachments for a session. Gets one page; to see more, run it again with the next page it gives.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)

Outputs

Result.

datalist
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List session messages

List all messages for a session with cursor-based pagination, ordered chronologically. Gets one page; to see more, run it again with the next page it gives.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)
Afteraftertext
After.
Firstfirstnumber
First.From 1 to 200.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "end_cursor": null,
    "has_next_page": false,
    "items": [],
    "total": null
  },
  "has_more": false,
  "next_cursor": null
}

List sessions

List sessions. Gets one page; to see more, run it again with the next page it gives.

Inputs

Afteraftertext
After.
Automation IDSautomation_idslist
Filter to sessions created by any of these automations
Categorycategorytext
Category.One of: 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, and 5 more.
Created aftercreated_afterdate and time
Choose a date and time; converted to Unix seconds automatically.
Created beforecreated_beforedate and time
Choose a date and time; converted to Unix seconds automatically.
Firstfirstnumber
First.From 1 to 200.
Is archivedis_archivedtrue/false
Is archived.
Originsoriginslist
Origins.One or more of: webapp, slack, teams, api, linear, jira, automation, cli, desktop, code_scan, other.
Parent session IDparent_session_idtext
Filter to child sessions spawned by this parent session
Playbookplaybook_idtext
Playbook id.
Repo namesrepo_nameslist
Filter by repository names (e.g., 'owner/repo')
Schedule IDschedule_idtext
Schedule id.
Service user IDSservice_user_idslist
Service user ids.
Session IDSsession_idslist
Session ids.
Tagstagslist
Tags.
Updated afterupdated_afterdate and time
Choose a date and time; converted to Unix seconds automatically.
Updated beforeupdated_beforedate and time
Choose a date and time; converted to Unix seconds automatically.
User IDSuser_idslist
User ids.
Sessionsession_idtext
Session id.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "end_cursor": null,
    "has_next_page": false,
    "items": [],
    "total": null
  },
  "has_more": false,
  "next_cursor": null
}

List sessions with insights

List sessions with detailed insights including message counts, session size classification, and AI-generated analysis. Gets one page; to see more, run it again with the next page it gives.

Inputs

Afteraftertext
After.
Automation IDSautomation_idslist
Filter to sessions created by any of these automations
Categorycategorytext
Category.One of: 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, and 5 more.
Created aftercreated_afterdate and time
Choose a date and time; converted to Unix seconds automatically.
Created beforecreated_beforedate and time
Choose a date and time; converted to Unix seconds automatically.
Firstfirstnumber
First.From 1 to 200.
Is archivedis_archivedtrue/false
Is archived.
Originsoriginslist
Origins.One or more of: webapp, slack, teams, api, linear, jira, automation, cli, desktop, code_scan, other.
Parent session IDparent_session_idtext
Filter to child sessions spawned by this parent session
Playbookplaybook_idtext
Playbook id.
Repo namesrepo_nameslist
Filter by repository names (e.g., 'owner/repo')
Schedule IDschedule_idtext
Schedule id.
Service user IDSservice_user_idslist
Service user ids.
Session IDSsession_idslist
Session ids.
Tagstagslist
Tags.
Updated afterupdated_afterdate and time
Choose a date and time; converted to Unix seconds automatically.
Updated beforeupdated_beforedate and time
Choose a date and time; converted to Unix seconds automatically.
User IDSuser_idslist
User ids.
Sessionsession_idtext
Session id.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "end_cursor": null,
    "has_next_page": false,
    "items": [],
    "total": null
  },
  "has_more": false,
  "next_cursor": null
}

Replace session tags

Replace all tags on a session.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)
TagstagslistRequired
Tags.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "tags": []
  },
  "has_more": false,
  "next_cursor": null
}

Send session message

Send a message to an active session. This can consume paid usage.

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)
Attachment URLSattachment_urlslist
Attachment urls.
MessagemessagetextRequired
Message.
Message as user IDmessage_as_user_idtext
Message as user id.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Terminate session

Terminate session

Inputs

Sessionsession_idtextRequired
Devin session ID (prefix: devin-)
Archivearchivetrue/false
Whether to archive the Devin session

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "acus_consumed": 0,
    "automation_id": null,
    "category": null,
    "child_session_ids": null,
    "created_at": 0,
    "devin_mode": null,
    "is_archived": false,
    "on_demand_usage": null,
    "org_id": null,
    "origin": null,
    "parent_session_id": null,
    "playbook_id": null,
    "pull_requests": [],
    "security_profile": null,
    "service_user_id": null,
    "session_id": "example",
    "status": "example",
    "status_detail": null,
    "structured_output": null,
    "subcategory": null,
    "tags": [],
    "title": null,
    "updated_at": 0,
    "url": "example",
    "user_id": null
  },
  "has_more": false,
  "next_cursor": null
}

Update knowledge note

Update a note for an organization.

Inputs

Notenote_idtextRequired
Knowledge note ID (prefix: note-)
BodybodytextRequired
Body.
Folder IDfolder_idtext
Folder id.
Is enabledis_enabledtrue/false
Is enabled.
NamenametextRequired
Name.
Pinned repopinned_repotext
Pinned repo.
TriggertriggertextRequired
Trigger.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "folder_id": null,
    "folder_path": "example",
    "is_enabled": false,
    "macro": null,
    "name": "example",
    "note_id": "example",
    "org_id": null,
    "pinned_repo": null,
    "trigger": "example",
    "updated_at": 0
  },
  "has_more": false,
  "next_cursor": null
}

Update playbook

Update a playbook for an organization.

Inputs

Playbookplaybook_idtextRequired
Playbook ID (prefix: playbook-)
BodybodytextRequired
Body.
Macromacrotext
Playbook macro identifier. Must start with '!' followed by one or more letters, digits, underscores, or hyphens. Example: '!my_macro' or '!my-macro'
Structured output schemastructured_output_schemaobject
JSON Schema (Draft 7) that sessions using this playbook will produce as structured output. Max 64KB. Must be self-contained (no external $ref).
TitletitletextRequired
Title.

Outputs

Result.

dataobject
The complete service response; record and list fields retain their API names.
has_moretrue/false
Whether the API reports another page.
next_cursortext
Pass to the pagination field for the next page, when Has more is true.
Example output
{
  "data": {
    "access_type": "example",
    "body": "example",
    "created_at": 0,
    "created_by": "example",
    "macro": null,
    "org_id": null,
    "playbook_id": "example",
    "structured_output_schema": null,
    "title": "example",
    "updated_at": 0,
    "updated_by": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page