Citera home
Browse documentation

Resource objects

Resource objects

Field reference for keys, brands, prompts, content, jobs, operations, and usage.

Summarize with AIChatGPTClaudePerplexity

api_key

Field

Type

id

uuid

object

"api_key"

name

string

token_prefix

string (rk_live_ab12cd34)

allowed_surfaces

("api"|"mcp")[]

scopes

scope[]

brand_ids

uuid[]

status

active | revoked | expired | disabled

expires_at, revoked_at, last_used_at

RFC 3339 | null

created_at

RFC 3339

rotated_from_key_id

uuid | null

token

string — only in create/rotate responses

brand

id, object: "brand", name, domain, additional_domains[], locale, primary_country, selected_models[], status (active|frozen), capabilities { prompt_library, visibility_metrics, content_generation, publishing }, created_at, updated_at.

brand_capabilities

id, object: "brand_capabilities", resource_families[], capabilities{…}, content_types[], destinations[] { integration_id, type, status, capabilities[], supported_content_types[], supports_draft }.

prompt

Field

Notes

id

prompt_<24 hex>

object

"prompt"

text

prompt text (untrusted)

category_id

brand | discovery

intent

see content types and enums

status

active

opportunity_score

0–1 | null

metrics

visibility_rate, avg_position, sentiment, mentioned_count, total_runs, scans_considered, last_scanned_at

trend

latest_visibility_rate, previous_visibility_rate, delta

by_model[]

{ model, visibility_rate, total_runs }

updated_at

RFC 3339

scan_run

id, object: "scan_run", status, source (cycle|legacy|null), models[], is_scheduled, metrics { share_of_voice, query_coverage, model_coverage, entity_coverage, total_mentions, sentiment_distribution }, failure ({code:"scan_failed"}|null), created_at, completed_at. Detail adds model_runs[] { id, model, status, progress, metrics, failure, created_at, completed_at }.

visibility

id (brand ID), object: "visibility", period, model, summary (scan metrics + latest_scan_id, latest_completed_at, previous metrics, delta {share_of_voice, query_coverage}), points[] { scan_id, completed_at, share_of_voice, query_coverage, model_coverage, entity_coverage, total_mentions }, has_more, next_cursor.

content

id, object: "content", title, slug, excerpt, content_type, status, quality_passed, tags[], word_count, persona_slug, seo { title, description }, author_name, source_recommendation_id, provenance { created_via: "api"|"app", api_job_id, request_id, api_key_id, model_used }, destination_compatibility[] { channel, compatible, supports_draft }, publications[] { id, channel, status, external_url, published_at }, created_at, updated_at, approved_at. Detail adds body (blocks or null), body_truncated, body_bytes.

recommendation

id, object: "recommendation", type, title, description, status, priority, opportunity { impact_score, keyword }, target { kind: "content_topic"|"page", page_id, page_title, source_url, cms }, related { prompt_text, content_id }, planned_date, created_at, completed_at. Detail adds topic or page.

job

id, object: "job", job_type (content_generation|publishing), status, brand_id, progress {stage?, percent?} | null, result {content_id?, operation_id?, publication_id?} | null, failure {code, retryable} | null, operation_units, created_at, started_at, completed_at, last_synced_at, stale.

The generation 202 response is a smaller shape: job_id, object, job_type, status, brand_id, content_id, estimated_operation_units, created_at.

integration

id (int_<kind>_<uuid>), object: "integration", type (channel), label, status (healthy|degraded|disconnected|unknown), capabilities[], supported_content_types[], supports_draft, last_checked_at.

publishing_preview

preview_id, object: "publishing_preview", content_id, integration_id, status (valid|invalid), destination_status, changed_fields[], preserved_fields[], warnings[] {code, message}, would_publish, content_fingerprint, expires_at, created_at.

publishing_operation

Accepted (202): job_id, operation_id, object, status: "queued", brand_id, integration_id, created_at.

Full: id, object, job_id, brand_id, content_id, integration_id, destination_status, status, result, external_url, verification { verified_at, method }, failure {code, retryable} | null, awaiting_verification, created_at, updated_at, completed_at.

Product resource

object, brand_id, page (dashboard path), data (object). Object names: calendar, calendar_topic, calendar_publication, results, results_refresh, website, website_resources, website_changes, website_change, website_activity, website_action, local, local_run, local_recommendation, local_location, image_bank, content_update.

api_usage

See API reference.