ProfileClaw

API guide

Context API

Context API is the default aggregated entrypoint. Start here, then expand only when the task requires it.

Path: /api/v1/context
Format: AI-first docs
Info

Contract-backed page

This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.

GET /api/v1/context

Get aggregated agent context

Agent-first aggregated context endpoint. Use this as the default entrypoint to obtain high-signal profile + assessments + resume summary, and optionally expand additional sections.

Required scopes

  • read:context

Request

  • view (query): compact (default) returns summary only. full includes the full careerGraph by default.
  • expand (query): Comma-separated expansions. Example: expand=careerGraph,alerts. Allowed: careerGraph,dynamicContext,alerts,careerHealth,dataSharing.
  • query (query): Only used when expand includes dynamicContext.
  • timeRange (query): Only used when expand includes dynamicContext.
  • includeMemories (query): Only used when expand includes dynamicContext.
  • careerGraph (query): Fine-grained output control when careerGraph is included. Use summary to reduce payload size.
  • resumeSkillsLimit (query): Limits the number of resume skills included in summary views (and careerGraph=summary).
  • alertsLimit (query): Limits the number of alerts returned when expand includes alerts.

Responses

  • 200: OK
  • 304: Not Modified
  • 400: Bad request
  • 401:
  • 402:
  • 403:
  • 404: Context not found
  • 429:
  • 500:

Errors

  • context.invalid_view
  • validation.bad_request
  • context.not_found

Examples

Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context" -H "Authorization: Bearer $PROFILECLAW_API_KEY"
Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context" -H "X-API-Key: $PROFILECLAW_API_KEY"
Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context?view=full" -H "Authorization: Bearer $PROFILECLAW_API_KEY"
Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context?expand=dynamicContext&query=product%20management&timeRange=recent" -H "Authorization: Bearer $PROFILECLAW_API_KEY"
Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context?expand=careerGraph&careerGraph=summary&resumeSkillsLimit=20" -H "Authorization: Bearer $PROFILECLAW_API_KEY"
Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/context" -H "Authorization: Bearer $PROFILECLAW_API_KEY" -H 'If-None-Match: "<etag-from-previous-response>"'

Related surfaces

Use these surfaces when you need deeper inspection or automation.

Open Reference
Open OpenAPI