Skip to main content
POST
/
public
/
v1
/
knowledge-base
/
documents
/
url
Create document from URL
curl --request POST \
  --url https://api.callin.io/api/public/v1/knowledge-base/documents/url \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "name": "<string>"
}
'
{
  "success": true,
  "data": {
    "documentId": "<string>",
    "type": "url",
    "name": "<string>",
    "details": {
      "url": "<string>"
    },
    "metadata": {
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "userId": "<string>",
        "userEmail": "<string>"
      }
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Body

application/json

Add a knowledge document by pointing at a public web page. The agent can use this content during calls.

​
url
string
required

URL to a page of documentation that the agent will have access to in order to interact with users.

​
name
string
required

A custom, human-readable name for the document.

Response

Document created

New URL-based document added to the knowledge base.

​
success
boolean
Example:

true

​
data
object

URL-sourced document. details holds only url; file fields live only on file documents.