Cody AI API
1.0

API for Cody AI

This is the documentation for version 1.0 of the API. Last update on May 4, 2024.

Base URL 
https://getcody.ai/api/v1

Update Conversation

POST /conversations/{id}

Update a conversation by its id.

Path parameters

  • id string Required

    Id of the conversation

application/json

Body

To use focus mode, add a list of document IDs to limit bot's knowledge base for this conversation.

  • name string Required
  • bot_id string Required
  • document_ids array[string]

    Only documents that exist in the folders the bot has access to are allowed. You can give bot access to all folders if you wish to limit documents from your whole knowledge base.

    Not more than 1000 elements.

Responses

  • • 200 application/json

    OK

    Hide response attribute Show response attribute object
  • • 422 application/json

    Request valiadtion failure.

    Hide response attributes Show response attributes object
POST /conversations/{id} 
curl \
 -X POST https://getcody.ai/api/v1/conversations/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","bot_id":"string","document_ids":["string"]}'
Request example 
{
  "name": "string",
  "bot_id": "string",
  "document_ids": [
    "string"
  ]
}
Response examples (200) 
{
  "data": {
    "id": "string",
    "name": "string",
    "bot_id": "string",
    "created_at": 42
  }
}
Response examples (422) 
{
  "message": "The selected bot id is invalid.",
  "errors": {
    "bot_id": [
      "The selected bot id is invalid."
    ]
  }
}