Skip to main content
Cody logo
  • Category: ai assistants
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: CODY
  • Version: 20261101_00

Tools

Slug: CODY_CREATE_CONVERSATIONTool to create a new conversation with a specified bot. Use when starting a new conversation thread with optional focus mode to limit bot’s knowledge base to specific documents.

Input Parameters

string
required
The conversation name.
string
required
The bot identifier to use for this conversation.
array
List of document IDs to enable focus mode. Only documents that exist in the folders the bot has access to are allowed. Maximum 1,000 elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_CREATE_DOCUMENTTool to create a new document with text or HTML content in Cody AI. Use when you need to add documents to Cody’s knowledge base with up to 768 KB of content.

Input Parameters

string
required
The document name.
string
required
Up to 768 KB of text or HTML content for the document. This field is required.
string
required
ID of the folder to store the document. This field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_CREATE_DOCUMENT_FROM_FILECreate a Cody knowledge-base document from a previously uploaded file key in a destination folder. The file is processed asynchronously.

Input Parameters

string
required
The key received after uploading a file via the /uploads/signed-url endpoint. This key identifies the uploaded file to be converted into a document.
string
required
ID of the destination folder for the document. This is required by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_CREATE_DOCUMENT_FROM_WEBPAGETool to create a document from a publicly accessible webpage URL. Use when you need to import content from a webpage into Cody AI. The webpage must be accessible without login. If request fails, ensure the URL is publicly accessible and not blocked by a firewall.

Input Parameters

string
required
Valid and publicly accessible webpage URL. The webpage must be accessible without login or authentication.
string
required
The folder identifier where the document will be stored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_CREATE_FOLDERTool to create a new folder in Cody AI for organizing content. Use when you need to create a folder to organize documents or conversations.

Input Parameters

string
required
The name of the folder to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_DELETE_CONVERSATIONTool to delete a conversation by its ID. Use when you need to permanently remove a conversation from the system.

Input Parameters

string
required
ID of the conversation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_DELETE_DOCUMENTTool to delete a document by id. Use when removing a document that is no longer needed.

Input Parameters

string
required
The document identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_GET_CONVERSATIONFetch details of a Cody AI conversation by its ID.

Input Parameters

string
required
The unique identifier of the conversation to retrieve.
string
Filters response to list document IDs the conversation focuses on. Accepts value: ‘document_ids’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_GET_DOCUMENTTool to retrieve a specific document by its identifier from Cody AI. Use when you need to get details about a particular document including its status, content URL, and metadata.

Input Parameters

string
required
The unique identifier of the document to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_GET_FOLDERTool to retrieve a specific folder by its identifier. Use when you need to get details about a folder.

Input Parameters

string
required
The unique identifier of the folder to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_GET_MESSAGETool to fetch a specific message by its ID from Cody AI. Use when you need to retrieve details about a particular message, with optional includes for sources or usage metrics.

Input Parameters

string
required
The unique identifier of the message to retrieve.
string
Extra attributes to include in the response. Accepted values are ‘sources’ (to include source documents) or ‘usage’ (to include token and credit consumption metrics). Separate multiple values with commas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_GET_UPLOADS_SIGNED_URLTool to get an AWS S3 signed upload URL for file uploads. Use when you need to obtain a signed URL to upload a file to Cody’s storage.

Input Parameters

string
required
Original file name you want to upload, must contain the file extension.
string
required
MIME content type of the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_LIST_BOTSList a page of bots in a Cody account, optionally filtering by keyword. Pagination metadata is returned for navigating additional pages.

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
string
Keyword to filter the list of bots to only those that at least partially match the bot name.
integer
Number of results per page. Defaults to 15 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_LIST_CONVERSATIONSList a page of conversations, optionally filtering by bot or name keyword and including document associations. Pagination metadata is returned for navigating additional pages.

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
string
Filters conversations to those using a specific bot. Provide the bot’s unique identifier.
string
Filters conversations by partial match against conversation names. Case-insensitive search.
string
When set to ‘document_ids’, returns document IDs the conversation focuses on. Use this to get additional context about conversations.
integer
Number of results per page. Defaults to 15 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_LIST_DOCUMENTSList a page of documents from a Cody AI account, optionally filtered by folder, conversation, or keyword. Returns document details including learning status and content URL, along with pagination metadata.

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
string
Keyword to filter the list to documents that partially match the name. Use for searching documents by name.
integer
Number of results per page. Defaults to 15 if not specified.
string
Id of the folder to list documents for. Use to filter documents by folder.
string
Id of the conversation to only list documents the conversation is focused on. Use to filter documents by conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_LIST_FOLDERSList a page of folders in the account, optionally filtered by keyword, with pagination metadata.

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
string
Keyword to filter the list to folders that partially match the name.
integer
Number of results per page. Defaults to 15 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_LIST_MESSAGESTool to retrieve a paginated list of messages from Cody, optionally filtered by conversation. Use when you need to list messages, with optional filtering by conversation_id and extra attributes (sources or usage).

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
string
Extra attributes to include in the response. Accepted values are ‘sources’ (to include source documents) or ‘usage’ (to include token and credit consumption metrics). Separate multiple values with commas.
integer
Number of results per page. Defaults to 10 if not specified.
string
Filters results to messages within a specific conversation. Provide the conversation ID to narrow down results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_SEND_MESSAGETool to send a message to Cody AI and receive an AI-generated response. Use when you need to send a user message to a conversation and get the AI’s reply.

Input Parameters

string
required
User message text to send (maximum 2000 characters).
string
required
Identifier for the conversation thread to send the message to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_SEND_MESSAGE_FOR_STREAMTool to send a message to Cody AI and receive a Server-Sent Events (SSE) stream URL for the AI response. Use when you need streaming responses instead of waiting for the complete message. The response contains a stream_url that can be used to connect to the SSE stream and receive the AI’s response in real-time chunks.

Input Parameters

string
required
The message content to send to the AI (maximum 2000 characters).
boolean
Controls response format. When false (default), returns 200 with stream URL in JSON. When true, returns 302 redirect to stream URL.
string
required
ID of the conversation to send the message to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_UPDATE_CONVERSATIONUpdate a conversation by ID with its name and bot ID, optionally setting document IDs to limit the bot’s knowledge base.

Input Parameters

string
required
The unique identifier of the conversation to update.
string
required
The conversation name to update.
string
required
The bot associated with this conversation.
array
Document IDs to limit the bot’s knowledge base. Only documents that exist in the folders the bot has access to are allowed. Maximum 1,000 elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODY_UPDATE_FOLDERTool to update a folder by its ID. Use when you need to modify an existing folder’s name.

Input Parameters

string
required
The unique identifier of the folder to update.
string
required
The new name for the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not