CopyHero
Back to CopyHero

Search Agent Guides

GET
/api/v1/agent-guides/search

Find bounded CopyHero playbooks for a concrete user intent.

Search before multi-step configuration, imports, pushes, workflow starts, or destructive actions. Results are deterministic metadata; call get with an exact returned slug to load only the selected guide.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

query*Query

Task or intent to match against deterministic guide metadata.

Match.*\S.*
Length1 <= length <= 300
limit?Limit

Preferred guide summary count; top-score ties may expand results up to the global maximum of 5 (never includes bodies).

Range1 <= value <= 5
Default3

Response Body

Successful Response

application/json
  1. response

Deterministically ranked guide summaries for one lexical query.

query*Query
count*Count
ambiguous*Ambiguous
results*array<>
fallback*array<>
Example Request
curl -X GET 'https://app.copyhero.app/api/v1/agent-guides/search?query=string'
Example Response
{  "query": "string",  "count": 0,  "ambiguous": true,  "results": [    {      "slug": "string",      "title": "string",      "summary": "string",      "category": "string",      "version": "string",      "status": "active",      "intents": [        "string"      ],      "related_tools": [        "string"      ],      "related_guides": [        "string"      ],      "reviewed_at": "2019-08-24",      "review_after": "2019-08-24",      "digest": "string",      "stale": true,      "stale_reasons": [        "string"      ],      "missing_related_tools": [        "string"      ],      "score": 1,      "matched_fields": [        "string"      ],      "matched_terms": [        "string"      ]    }  ],  "fallback": [    {      "slug": "string",      "title": "string",      "summary": "string",      "category": "string",      "version": "string",      "status": "active",      "intents": [        "string"      ],      "related_tools": [        "string"      ],      "related_guides": [        "string"      ],      "reviewed_at": "2019-08-24",      "review_after": "2019-08-24",      "digest": "string",      "stale": true,      "stale_reasons": [        "string"      ],      "missing_related_tools": [        "string"      ]    }  ]}

List Agent Guides GET

List compact CopyHero workflow guides without loading their bodies. Use this for discovery when no specific intent is available. For a concrete task, prefer search, then fetch one matching guide before multi-step work.

Get Credit Usage By Job Type GET

Daily credits per job type for the current organization, voided credits excluded.