Devin

使用说明

Integrate Devin into your workflow. Create sessions to assign coding tasks, send messages to guide active sessions, and retrieve session status and results. Devin autonomously writes, runs, and tests code.

工具

`devin_create_session`

Create a new Devin session with a prompt. Devin will autonomously work on the task described in the prompt.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`prompt`	string	是	The task prompt for Devin to work on
`playbookId`	string	否	Optional playbook ID to guide the session
`maxAcuLimit`	number	否	Maximum ACU limit for the session
`tags`	string	否	Comma-separated tags for the session

输出

参数	类型	描述
`sessionId`	string	Unique identifier for the session
`url`	string	URL to view the session in the Devin UI
`status`	string	Session status (new, claimed, running, exit, error, suspended, resuming)
`statusDetail`	string	Detailed status (working, waiting_for_user, waiting_for_approval, finished, inactivity, etc.)
`title`	string	Session title
`createdAt`	number	Unix timestamp when the session was created
`updatedAt`	number	Unix timestamp when the session was last updated
`acusConsumed`	number	ACUs consumed by the session
`tags`	json	Tags associated with the session (array of strings)
`pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
`structuredOutput`	json	Structured output from the session
`playbookId`	string	Associated playbook ID

`devin_get_session`

Retrieve details of an existing Devin session including status, tags, pull requests, and structured output.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`sessionId`	string	是	The session ID to retrieve

输出

参数	类型	描述
`sessionId`	string	Unique identifier for the session
`url`	string	URL to view the session in the Devin UI
`status`	string	Session status (new, claimed, running, exit, error, suspended, resuming)
`statusDetail`	string	Detailed status (working, waiting_for_user, waiting_for_approval, finished, inactivity, etc.)
`title`	string	Session title
`createdAt`	number	Unix timestamp when the session was created
`updatedAt`	number	Unix timestamp when the session was last updated
`acusConsumed`	number	ACUs consumed by the session
`tags`	json	Tags associated with the session (array of strings)
`pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
`structuredOutput`	json	Structured output from the session
`playbookId`	string	Associated playbook ID

`devin_list_sessions`

List Devin sessions in the organization. Returns up to 100 sessions by default.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`limit`	number	否	Maximum number of sessions to return (1-200, default: 100)

输出

参数	类型	描述
`sessions`	array	List of Devin sessions
↳ `sessionId`	string	Unique identifier for the session
↳ `url`	string	URL to view the session
↳ `status`	string	Session status
↳ `statusDetail`	string	Detailed status
↳ `title`	string	Session title
↳ `createdAt`	number	Creation timestamp (Unix)
↳ `updatedAt`	number	Last updated timestamp (Unix)
↳ `tags`	json	Session tags (array of strings)
↳ `acusConsumed`	number	ACUs consumed by the session
↳ `pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
↳ `playbookId`	string	Associated playbook ID
↳ `isArchived`	boolean	Whether the session is archived

`devin_send_message`

Send a message to a Devin session. If the session is suspended, it will be automatically resumed. Returns the updated session state.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`sessionId`	string	是	The session ID to send the message to
`message`	string	是	The message to send to Devin

输出

参数	类型	描述
`sessionId`	string	Unique identifier for the session
`url`	string	URL to view the session in the Devin UI
`status`	string	Session status (new, claimed, running, exit, error, suspended, resuming)
`statusDetail`	string	Detailed status (working, waiting_for_user, waiting_for_approval, finished, inactivity, etc.)
`title`	string	Session title
`createdAt`	number	Unix timestamp when the session was created
`updatedAt`	number	Unix timestamp when the session was last updated
`acusConsumed`	number	ACUs consumed by the session
`tags`	json	Tags associated with the session (array of strings)
`pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
`structuredOutput`	json	Structured output from the session
`playbookId`	string	Associated playbook ID

`devin_list_session_messages`

List the messages exchanged in a Devin session, including messages from both the user and Devin.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to list messages for
`limit`	number	否	Maximum number of messages to return (1-200, default: 100)
`after`	string	否	Pagination cursor (endCursor from a previous response) to fetch the next page

输出

参数	类型	描述
`messages`	array	Messages exchanged in the session
↳ `eventId`	string	Unique identifier for the message event
↳ `source`	string	Origin of the message (devin or user)
↳ `message`	string	The message content
↳ `createdAt`	number	Unix timestamp when the message was created
`endCursor`	string	Pagination cursor for the next page, or null if last page
`hasNextPage`	boolean	Whether more messages are available
`total`	number	Total number of messages, if provided

`devin_list_session_attachments`

List the files uploaded to or produced by a Devin session.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to list attachments for

输出

参数	类型	描述
`attachments`	array	Attachments associated with the session
↳ `attachmentId`	string	Unique identifier for the attachment
↳ `name`	string	Attachment file name
↳ `url`	string	URL to download the attachment
↳ `source`	string	Origin of the attachment (devin or user)
↳ `contentType`	string	MIME type of the attachment

`devin_get_session_tags`

Retrieve the tags currently applied to a Devin session.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to retrieve tags for

输出

参数	类型	描述
`tags`	json	Tags applied to the session (array of strings)

`devin_append_session_tags`

Add tags to a Devin session without removing existing tags (max 50 tags total).

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to add tags to
`tags`	string	是	Tags to append to the session (comma-separated string or array of strings)

输出

参数	类型	描述
`tags`	json	Updated list of tags on the session (array of strings)

`devin_replace_session_tags`

Replace all tags on a Devin session with a new set of tags (max 50 tags).

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to replace tags on
`tags`	string	是	Tags that will overwrite the existing tags (comma-separated string or array of strings)

输出

参数	类型	描述
`tags`	json	Updated list of tags on the session (array of strings)

`devin_archive_session`

Archive a Devin session. Archived sessions can still be viewed but cannot be modified or resumed.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to archive

输出

参数	类型	描述
`sessionId`	string	Unique identifier for the session
`url`	string	URL to view the session in the Devin UI
`status`	string	Session status (new, claimed, running, exit, error, suspended, resuming)
`statusDetail`	string	Detailed status (working, waiting_for_user, waiting_for_approval, finished, inactivity, etc.)
`title`	string	Session title
`createdAt`	number	Unix timestamp when the session was created
`updatedAt`	number	Unix timestamp when the session was last updated
`acusConsumed`	number	ACUs consumed by the session
`tags`	json	Tags associated with the session (array of strings)
`pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
`structuredOutput`	json	Structured output from the session
`playbookId`	string	Associated playbook ID
`isArchived`	boolean	Whether the session is archived

`devin_terminate_session`

Terminate a Devin session. Optionally archive the session instead of permanently terminating it.

输入

参数	类型	必填	描述
`apiKey`	string	是	Devin API key (service user credential starting with cog_)
`orgId`	string	是	Devin organization ID (prefixed with org-)
`sessionId`	string	是	The session ID to terminate
`archive`	boolean	否	Archive the session instead of permanently terminating it (default: false)

输出

参数	类型	描述
`sessionId`	string	Unique identifier for the session
`url`	string	URL to view the session in the Devin UI
`status`	string	Session status (new, claimed, running, exit, error, suspended, resuming)
`statusDetail`	string	Detailed status (working, waiting_for_user, waiting_for_approval, finished, inactivity, etc.)
`title`	string	Session title
`createdAt`	number	Unix timestamp when the session was created
`updatedAt`	number	Unix timestamp when the session was last updated
`acusConsumed`	number	ACUs consumed by the session
`tags`	json	Tags associated with the session (array of strings)
`pullRequests`	json	Pull requests created during the session ([{pr_url, pr_state}])
`structuredOutput`	json	Structured output from the session
`playbookId`	string	Associated playbook ID
`isArchived`	boolean	Whether the session is archived

Devin

On this page