List doc collections

GET

/v1/doc-collections

const url = 'https://api.gopromptless.ai/v1/doc-collections';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.gopromptless.ai/v1/doc-collections \
  --header 'Authorization: Bearer <token>'

List the doc collections configured for your organization. Each entry carries its id, name, platform, and default_branch. The response is not paged.

Authorizations

bearerAuth

Responses

200

The doc collections configured for the organization.

application/json

DocCollectionsResponse

The doc collections configured for the organization. This response is not paged.

object

doc_collections

required

Doc Collections

Array<object>

DocCollection

A doc collection configured for the organization.

object

required

string format: uuid

name

required

Name

string

platform

required

Platform

string

default_branch

required

Default Branch

string

Example

{
  "doc_collections": [
    {
      "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
      "name": "acme/docs",
      "platform": "github",
      "default_branch": "main"
    }
  ]
}

401

The API key is missing, invalid, or revoked.

application/json

ApiTriggerErrorResponse

Error body returned when an API trigger request is rejected.

object

error

required

Error

Stable machine-readable error code.

string

message

required

Message

Human-readable explanation of the error.

string

Example

{
  "error": "authentication_failed",
  "message": "Authentication failed."
}

503

The read store is temporarily unavailable (runtime_store_unavailable).

application/json

ApiTriggerErrorResponse

Error body returned when an API trigger request is rejected.

object

error

required

Error

Stable machine-readable error code.

string

message

required

Message

Human-readable explanation of the error.

string

Example

{
  "error": "authentication_failed",
  "message": "Authentication failed."
}