Ask CRM with natural language

POST/v1/crm/ask

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

limitinteger<int32>

querystringrequired

min length 2

Responses

200OK

explanationstringrequired

object_kindstringrequired

querystringrequired

recordsCrmObjectRecordItem[] | nullrequired

Show properties

Array of CrmObjectRecordItem

created_atstringrequired

custom_fieldsanyrequired

display_namestringrequired

enrichment_summaryobject

fieldsobjectrequired

idstringrequired

kindstringrequired

metadataanyrequired

relationships_summaryobjectrequired

updated_atstringrequired

searchstring

totalinteger<int64>required

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/crm/ask" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "query": "string"
}'

const response = await fetch("/v1/crm/ask", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "limit": 0,
  "query": "string"
})
});

import requests

response = requests.post(
    "/v1/crm/ask",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "limit": 0,
  "query": "string"
},
)

Response

{
  "explanation": "string",
  "object_kind": "string",
  "query": "string",
  "records": [
    {
      "created_at": "string",
      "custom_fields": "string",
      "display_name": "string",
      "enrichment_summary": {},
      "fields": {},
      "id": "string",
      "kind": "string",
      "metadata": "string",
      "relationships_summary": {},
      "updated_at": "string"
    }
  ],
  "search": "string",
  "total": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}