Cody AI API documentation

Get Message

GET /messages/{id}

Fetch a message by its id.

Path parameters

id string Required

Query parameters

includes string(csv)

Extra message attributes to include in the response.

Value is sources.

Responses

• 200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes
  
  id string
  
  content string Required
  
  conversation_id string Required
  
  machine boolean
  
  This is true for all LLM generated messages.
  
  failed_responding boolean
  
  This will be true if the response generation for a message had failed.
  
  flagged boolean
  
  This is true when message is in violation of OpenAI usage policy.
  
  created_at integer(int64)
  
  Unix timestamp in seconds
  
  sources object
  
  Hide sources attribute Show sources attribute
  
  data array[object]
  
  Any of:
  Source Written object Source Webpage object Source File object
  
  Hide attributes Show attributes
  
  type string
  
  Default value is written.
  
  document_id string
  
  document_name string
  
  document_url string(uri)
  
  created_at integer(int64)
  
  Hide attributes Show attributes
  
  type string
  
  Default value is webpage.
  
  document_id string
  
  document_name string
  
  document_url string(uri)
  
  webpage_url string(uri)
  
  created_at integer(int64)
  
  Hide attributes Show attributes
  
  type string
  
  Default value is file.
  
  document_id string
  
  document_name string
  
  document_url string(uri)
  
  file_name string
  
  created_at integer(int64)

GET /messages/{id}

curl \
 -X GET https://getcody.ai/api/v1/messages/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "id": "string",
    "content": "string",
    "conversation_id": "string",
    "machine": true,
    "failed_responding": true,
    "flagged": true,
    "created_at": 42,
    "sources": {
      "data": [
        {
          "type": "written",
          "document_id": "Jw31Pv6PMmro",
          "document_name": "How to bake cake",
          "document_url": "https://getcody.ai/directories/1/documents/1",
          "created_at": 1693013531
        }
      ]
    }
  }
}