Skip to main content
API docs by Redocly

Data Provider API specification (1.0.0)

Download OpenAPI specification:Download



This API specification is to be implemented by Data Providers who would like to source data into Assistants Hub for use with their assistants. Assistants Hub will use these APIs to connect to the Data Provider.

To securely manage data connections for various assistants, OAuth 2.0 client credentials flow for machine-to-machine authentication will be used. This provides a robust and secure way for systems to interact without human intervention.

Auth

OAuth 2.0 Token Endpoint

This endpoint is used to obtain access tokens in the client credentials flow. Assistants Hub will provide its client_id and client_secret and receive a token in return.

Authorizations:
OAuth2
Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Default: "client_credentials"

Grant type value must be 'client_credentials'

client_id
required
string

The client ID issued to Assistants Hub by the data provider

client_secret
required
string

The client secret issued to Assistants Hub by the data provider

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string"
}

Connections

Create a new data connection on the data provider by Assistants Hub

Authorizations:
OAuth2
Request Body schema: application/json
required
providerId
required
string
assistantId
required
string
type
required
string
source
required
string

Responses

Request samples

Content type
application/json
{
  • "providerId": "provider_01HYHZ576RYCG07ZJ8R7X3HDJV",
  • "assistantId": "asst_01HYHZAW0FSZRTQ19CDKBER8HF",
  • "type": "crawl",
  • "source": "https://www.example.com"
}

Response samples

Content type
application/json
{
  • "connectionId": "conn_01HYHZBMX7V27TSCJP55PJ61TX",
  • "providerId": "string",
  • "assistantId": "string",
  • "type": "string",
  • "source": "string"
}

Update an existing data connection on the data provider by Assistants Hub

Authorizations:
OAuth2
path Parameters
id
required
string
Example: conn_01HYHZBMX7V27TSCJP55PJ61TX
Request Body schema: application/json
required
providerId
required
string
assistantId
required
string
type
required
string
source
required
string

Responses

Request samples

Content type
application/json
{
  • "providerId": "provider_01HYHZ576RYCG07ZJ8R7X3HDJV",
  • "assistantId": "asst_01HYHZAW0FSZRTQ19CDKBER8HF",
  • "type": "crawl",
  • "source": "https://www.example.com"
}

Retrieve details of a data connection from the data provider by Assistants Hub

Authorizations:
OAuth2
path Parameters
id
required
string
Example: conn_01HYHZBMX7V27TSCJP55PJ61TX

Responses

Response samples

Content type
application/json
{
  • "connectionId": "conn_01HYHZBMX7V27TSCJP55PJ61TX",
  • "providerId": "string",
  • "assistantId": "string",
  • "type": "string",
  • "source": "string"
}

Delete a data connection on the data provider by Assistants Hub

Authorizations:
OAuth2
path Parameters
id
required
string
Example: conn_01HYHZBMX7V27TSCJP55PJ61TX

Responses