Skip to main content
GET
/
api
/
v1
/
apps
/
{appId}
/
route-candidates
List App route candidates
curl --request GET \
  --url https://app.promptingco.com/api/v1/apps/{appId}/route-candidates \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "data": {
    "appId": "<string>",
    "candidateCount": 1,
    "candidates": [
      {
        "targetType": "product_document",
        "targetId": "<string>",
        "suggestedPath": "<string>",
        "pathStatus": "already_routed",
        "existingRoute": {
          "id": "<string>",
          "path": "<string>"
        },
        "pathConflict": {
          "id": "<string>",
          "path": "<string>",
          "targetType": "<string>",
          "targetId": "<string>"
        },
        "target": {
          "id": "<string>",
          "title": "<string>",
          "filePath": "<string>",
          "sourceUrl": "<string>",
          "status": "<string>",
          "type": "<string>",
          "redirectToUrl": "<string>",
          "productId": "<string>"
        },
        "product": {
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>"
        }
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

appId
string
required
Minimum string length: 1

Query Parameters

productId
string
Minimum string length: 1
status
enum<string>
default:published
Available options:
draft,
published
includeRouted
boolean
default:false

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required