Skip to content
WP EngineDocumentation

List knowledge base collections

GET
/v1/kb/collections
<?php


$client = new \GuzzleHttp\Client();


$response = $client->request('GET', 'https://api.ai.wpengine.com/v1/kb/collections', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);


echo $response->getBody();

Returns all collections in the caller’s project. Requires a valid WP Engine bearer token.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The project’s collections

Media typeapplication/json
object
collections
required
Array<object>
object
id
required

Unique identifier for the collection.

string
project_id
required

The project the collection belongs to.

string
name
required

Human-readable collection name.

string
description
required

Deprecated. Not used by the LLM search tool.

string
created_at
required

When the collection was created (UTC).

string format: date-time
updated_at
required

When the collection was last updated (UTC).

string format: date-time
metadata

Structured metadata bag populated by the producer plugin during collection sync. Omitted from the response when the collection has no metadata set.

object
Example
{
  "collections": [
    {
      "name": "Product documentation",
      "description": "Product documentation, API reference guides, and release changelogs."
    }
  ]
}

401

Section titled “401”

Missing or invalid bearer token

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
integer
request_id
required

Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports.

string
Example
{
  "error": {
    "type": "invalid_request_error",
    "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5"
  }
}

Headers

Section titled “Headers”
WWW-Authenticate
string
Example
Bearer realm="ai-services"

403

Section titled “403”

The token is valid, but the caller is not permitted to perform this action — either its scope/permission is insufficient or the authenticated user is not authorized for the target account (error type “permission_error”). On /v1/chat/completions specifically, a 403 with error type “content_policy_violation” instead means the request content was blocked by content moderation policy; that response never identifies which filter or category matched.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
integer
request_id
required

Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports.

string
Example
{
  "error": {
    "type": "invalid_request_error",
    "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5"
  }
}

429

Section titled “429”

Rate limit exceeded. The request was throttled at the edge; wait and retry later. The response body is a short HTML page generated by the load balancer, not a structured JSON error — clients should rely on the 429 status code rather than parsing the body.

Media typetext/html
string

503

Section titled “503”

The knowledge base is not currently available. Retry after a short delay.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
integer
request_id
required

Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports.

string
Example
{
  "error": {
    "type": "invalid_request_error",
    "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5"
  }
}