> ## Documentation Index > Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt > Use this file to discover all available pages before exploring further. # Preview discovery intent > Preview an intent and validate search phrases without collecting or charging. ## OpenAPI ````yaml /openapi.json post /v1/discovery/preview openapi: 3.1.0 info: title: Sigmora API version: 1.0.0 description: >- The priced, versioned public API. Every call authenticates with a workspace API key (`Authorization: Bearer sk_live_…`), names the project it files its output under, and reports what it cost. `GET /v1/capabilities` answers what this deployment can serve right now and at what price; anything it reports as unavailable answers 503 `capability_unavailable` rather than 404. servers: - url: https://api.sigmora.org security: - bearerAuth: [] tags: - name: Meta description: What this deployment serves, what it costs, and what you have spent. - name: Projects description: The container every capability files its output under. - name: Sessions description: Durable bindings between an external harness session and one project. - name: Assets description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.' - name: Jobs description: Where every asynchronous capability is collected, whatever produced it. - name: Text description: Scripts, research, articles, translation and question sets. - name: Video description: Narrated renders, footage edits, shorts and moment selection. - name: UGC description: >- Creator-led vertical videos: AI creators, their faces and voices, frames and clips. - name: Editing description: >- Sigma, the editor: conversational turns, granular transcript edits, approvals. - name: 3D description: Animated 3D renders from a description or a photograph. - name: Image description: Thumbnails, sized for the platform they are posted to. - name: Audio description: Generated music and audio engineering in Audiotool projects. - name: Publishing description: Connected destinations and queued posts. - name: Webhooks description: Signed, at-least-once delivery of job and publishing events. - name: Workflows description: Context snapshots, versioned recipes, costed proposals and their runs. - name: Agents description: Describe an outcome and let a bounded plan of capabilities run. - name: Research description: >- Observed hooks, creator outliers and production briefs from saved analyses. - name: Themes description: The canonical content taxonomy, and the niche profiles built on it. - name: Signals description: Evidence-backed trends and scored viral content. - name: Discovery description: Compiled watch plans, their runs, and source freshness. - name: Watchlist description: 'Accounts you watch: their usual reach and the posts that beat it.' - name: Performance description: Your own channels' videos against their usual, and fixes to live videos. - name: Autopilot description: The durable trend-to-distribution workflow and its checkpoints. - name: Campaigns description: Distribution records shared by the API, the dashboard and autopilot. - name: Brands description: >- Cross-platform identities with their own voice, rules and publishing commitments. - name: Products description: What a campaign promotes. paths: /v1/discovery/preview: post: tags: - Discovery summary: Preview discovery intent description: >- Preview an intent and validate search phrases without collecting or charging. operationId: postDiscoveryPreview requestBody: required: true content: application/json: schema: type: object properties: intent: type: string minLength: 10 maxLength: 500 description: >- The audience outcome or content opportunity to research, in at least 10 characters. keywords: default: [] description: >- Optional seed search phrases. Send at most 12; defaults to an empty list. maxItems: 12 type: array items: type: string minLength: 2 maxLength: 120 excludeKeywords: default: [] description: >- Optional phrases to exclude from search results. Send at most 20; defaults to an empty list. maxItems: 20 type: array items: type: string minLength: 2 maxLength: 120 platforms: default: - youtube_shorts description: Platforms to search. Defaults to youtube_shorts. minItems: 1 maxItems: 10 type: array items: type: string enum: - youtube_shorts - instagram_reels - facebook_reels - tiktok - twitter - reddit - news - medium - google_news - google_web required: - intent example: intent: >- Budgeting habits that help first-job earners build an emergency fund. keywords: - first salary budget - emergency fund tips platforms: - youtube_shorts - tiktok responses: '200': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true preview: type: object properties: intent: type: string keywords: type: array items: type: string excludeKeywords: type: array items: type: string queries: type: array items: type: object properties: platform: type: string enum: - youtube_shorts - instagram_reels - facebook_reels - tiktok - twitter - reddit - news - medium - google_news - google_web terms: type: array items: type: string required: - platform - terms quality: type: object properties: passes: type: boolean issues: type: array items: type: string method: type: string required: - passes - issues - method costCredits: type: number const: 0 createsResources: type: boolean const: false configPatch: type: object properties: intent: type: string minLength: 10 maxLength: 500 description: >- The audience outcome or content opportunity to research, in at least 10 characters. keywords: default: [] description: >- Optional seed search phrases. Send at most 12; defaults to an empty list. maxItems: 12 type: array items: type: string minLength: 2 maxLength: 120 excludeKeywords: default: [] description: >- Optional phrases to exclude from search results. Send at most 20; defaults to an empty list. maxItems: 20 type: array items: type: string minLength: 2 maxLength: 120 platforms: default: - youtube_shorts description: Platforms to search. Defaults to youtube_shorts. minItems: 1 maxItems: 10 type: array items: type: string enum: - youtube_shorts - instagram_reels - facebook_reels - tiktok - twitter - reddit - news - medium - google_news - google_web required: - intent required: - intent - keywords - excludeKeywords - queries - quality - costCredits - createsResources - configPatch required: - success - preview additionalProperties: {} '400': description: 'Failure. `code` is one of: invalid_request.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: 'Failure. `code` is one of: unauthorized.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: 'Failure. `code` is one of: forbidden, origin_not_allowed.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'Failure. `code` is one of: not_found.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: 'Failure. `code` is one of: rate_limited.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'Failure. `code` is one of: upstream_error, internal_error.' content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- Failure. `code` is one of: capability_unavailable, upstream_unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object required: - success - error - code properties: success: const: false error: type: string description: >- Human-readable. Copy may change between releases — do not match on it. code: type: string enum: - invalid_request - unauthorized - forbidden - origin_not_allowed - not_found - conflict - payload_too_large - insufficient_credits - budget_capped - content_not_cleared - rate_limited - capability_unavailable - upstream_unavailable - upstream_error - internal_error description: Stable machine-readable cause. Branch on this. details: description: Optional structured context, e.g. the credits shortfall. requestId: type: string description: >- Identifies this request in our logs. Include it when you contact support. timestamp: type: string format: date-time description: When the failure was produced. securitySchemes: bearerAuth: type: http scheme: bearer description: A workspace API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.