cURL
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>" } } ] } }
Organization-scoped API key. Available scopes:
1
draft
published
Successful response
true
Show child attributes