Skip to main content
API docs by Redocly

Ragpi (0.2.x)

Download OpenAPI specification:Download

Ragpi is an AI assistant specialized in retrieving and synthesizing technical information to provide relevant answers to queries.

Healthcheck

Healthcheck

Authorizations:
APIKeyHeader

Responses

Response samples

Content type
application/json
{
  • "api": {
    },
  • "redis": {
    },
  • "workers": {
    }
}

Sources

List Sources

Authorizations:
APIKeyHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Source

Authorizations:
APIKeyHeader
Request Body schema: application/json
required
name
required
string (Name) [ 3 .. 50 ] characters
description
required
string (Description)
required
any (Connector)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "connector": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "source": {
    },
  • "message": "string"
}

Get Source

Authorizations:
APIKeyHeader
path Parameters
source_name
required
string (Source Name)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "num_docs": 0,
  • "last_task_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "connector": {
    }
}

Update Source

Authorizations:
APIKeyHeader
path Parameters
source_name
required
string (Source Name)
Request Body schema: application/json
required
sync
boolean (Sync)
Default: true
Description (string) or Description (null) (Description)
Connector (any) or Connector (null) (Connector)

Responses

Request samples

Content type
application/json
{
  • "sync": true,
  • "description": "string",
  • "connector": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "source": {
    },
  • "message": "string"
}

Delete Source

Authorizations:
APIKeyHeader
path Parameters
source_name
required
string (Source Name)

Responses

Response samples

Content type
application/json
{
  • "detail": "Source 'example' not found"
}

Get Source Documents

Authorizations:
APIKeyHeader
path Parameters
source_name
required
string (Source Name)
query Parameters
limit
integer (Limit)
Default: 100
offset
integer (Offset)
Default: 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search Source

Authorizations:
APIKeyHeader
path Parameters
source_name
required
string (Source Name)
query Parameters
query
required
string (Query)
top_k
integer (Top K)
Default: 10

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Chat

Chat

Authorizations:
APIKeyHeader
Request Body schema: application/json
required
Array of Sources (strings) or Sources (null) (Sources)
model
string (Model)
Default: "gpt-4o"
required
Array of objects (Messages)

Responses

Request samples

Content type
application/json
{
  • "sources": [
    ],
  • "model": "gpt-4o",
  • "messages": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "retrieved_documents": [
    ]
}

Tasks

List Tasks

Authorizations:
APIKeyHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Task

Authorizations:
APIKeyHeader
path Parameters
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "completed_at": "string",
  • "metadata": { }
}

Terminate Task

Authorizations:
APIKeyHeader
path Parameters
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "message": "Terminating task 'example'"
}