{"openapi":"3.1.0","info":{"title":"Caelario API","description":"Create and monitor public social-data extraction jobs, batches and schedules with a Caelario API key.","version":"1.0.0"},"paths":{"/v1/platforms":{"get":{"tags":["platforms"],"summary":"List Platforms","operationId":"list_platforms_v1_platforms_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlatformResponse"},"type":"array","title":"Response List Platforms V1 Platforms Get"}}}}}}},"/v1/account":{"get":{"tags":["account"],"summary":"Account","operationId":"account_v1_account_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/jobs":{"post":{"tags":["extractions"],"summary":"Create Job","operationId":"create_job_v1_jobs_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Idempotency-Key"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractionRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["extractions"],"summary":"List Jobs","operationId":"list_jobs_v1_jobs_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobResponse"},"title":"Response List Jobs V1 Jobs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batches":{"post":{"tags":["extractions"],"summary":"Create Batch","operationId":"create_batch_v1_batches_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Idempotency-Key"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchExtractionRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["extractions"],"summary":"List Batches","operationId":"list_batches_v1_batches_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"include_jobs","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Jobs"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BatchResponse"},"title":"Response List Batches V1 Batches Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schedules":{"post":{"tags":["schedules"],"summary":"Create Schedule","operationId":"create_schedule_v1_schedules_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["schedules"],"summary":"List Schedules","operationId":"list_schedules_v1_schedules_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleResponse"},"title":"Response List Schedules V1 Schedules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schedules/{schedule_id}":{"get":{"tags":["schedules"],"summary":"Get Schedule","operationId":"get_schedule_v1_schedules__schedule_id__get","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["schedules"],"summary":"Update Schedule","operationId":"update_schedule_v1_schedules__schedule_id__put","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["schedules"],"summary":"Delete Schedule","operationId":"delete_schedule_v1_schedules__schedule_id__delete","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schedules/{schedule_id}/pause":{"post":{"tags":["schedules"],"summary":"Pause Schedule","operationId":"pause_schedule_v1_schedules__schedule_id__pause_post","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schedules/{schedule_id}/resume":{"post":{"tags":["schedules"],"summary":"Resume Schedule","operationId":"resume_schedule_v1_schedules__schedule_id__resume_post","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schedules/{schedule_id}/run":{"post":{"tags":["schedules"],"summary":"Run Schedule Now","operationId":"run_schedule_now_v1_schedules__schedule_id__run_post","parameters":[{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","title":"Schedule Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batches/{batch_id}":{"get":{"tags":["extractions"],"summary":"Get Batch","operationId":"get_batch_v1_batches__batch_id__get","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batches/{batch_id}/cancel":{"post":{"tags":["extractions"],"summary":"Cancel Batch","operationId":"cancel_batch_v1_batches__batch_id__cancel_post","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batches/{batch_id}/export":{"get":{"tags":["extractions"],"summary":"Export Batch","operationId":"export_batch_v1_batches__batch_id__export_get","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","csv","xlsx"],"type":"string","default":"json","title":"Format"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/jobs/{job_id}":{"get":{"tags":["extractions"],"summary":"Get Job","operationId":"get_job_v1_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/jobs/{job_id}/cancel":{"post":{"tags":["extractions"],"summary":"Cancel Job","operationId":"cancel_job_v1_jobs__job_id__cancel_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/jobs/{job_id}/export":{"get":{"tags":["extractions"],"summary":"Export Job","operationId":"export_job_v1_jobs__job_id__export_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","csv","xlsx"],"type":"string","default":"json","title":"Format"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage/current":{"get":{"tags":["usage"],"summary":"Current Usage","operationId":"current_usage_v1_usage_current_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-Workspace-ID","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"X-Workspace-Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AccountResponse":{"properties":{"organization_id":{"type":"string","title":"Organization Id"},"organization_name":{"type":"string","title":"Organization Name"},"monthly_quota":{"type":"integer","title":"Monthly Quota"},"rate_limit_per_minute":{"type":"integer","title":"Rate Limit Per Minute"},"max_result_limit":{"type":"integer","title":"Max Result Limit"},"max_active_jobs":{"type":"integer","title":"Max Active Jobs"},"authenticated_key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authenticated Key Id"},"auth_type":{"type":"string","enum":["api_key","session"],"title":"Auth Type","default":"api_key"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"user":{"anyOf":[{"$ref":"#/components/schemas/UserResponse"},{"type":"null"}]},"workspaces":{"items":{"$ref":"#/components/schemas/WorkspaceResponse"},"type":"array","title":"Workspaces"}},"type":"object","required":["organization_id","organization_name","monthly_quota","rate_limit_per_minute","max_result_limit","max_active_jobs","authenticated_key_id"],"title":"AccountResponse"},"BatchExtractionRequest":{"properties":{"platform":{"type":"string","maxLength":30,"minLength":1,"title":"Platform","default":"instagram"},"operation":{"type":"string","enum":["profile","posts","reels","comments","highlights","stories","hashtag","search","post","video","transcript"],"title":"Operation"},"targets":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Targets"},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","default":12},"include_posts":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Include Posts","default":0}},"additionalProperties":false,"type":"object","required":["operation","targets"],"title":"BatchExtractionRequest","description":"One operation applied to an ordered set of independent public targets."},"BatchResponse":{"properties":{"id":{"type":"string","title":"Id"},"platform":{"type":"string","title":"Platform"},"operation":{"type":"string","title":"Operation"},"requested_limit":{"type":"integer","title":"Requested Limit"},"include_posts":{"type":"integer","title":"Include Posts","default":0},"target_count":{"type":"integer","title":"Target Count"},"status":{"type":"string","title":"Status"},"queued_count":{"type":"integer","title":"Queued Count"},"running_count":{"type":"integer","title":"Running Count"},"completed_count":{"type":"integer","title":"Completed Count"},"failed_count":{"type":"integer","title":"Failed Count"},"cancelled_count":{"type":"integer","title":"Cancelled Count"},"result_count":{"type":"integer","title":"Result Count"},"reserved_credits":{"type":"integer","title":"Reserved Credits"},"billed_credits":{"type":"integer","title":"Billed Credits"},"cancel_requested_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancel Requested At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"jobs":{"items":{"$ref":"#/components/schemas/JobResponse"},"type":"array","title":"Jobs"},"idempotent_replay":{"type":"boolean","title":"Idempotent Replay","default":false}},"type":"object","required":["id","platform","operation","requested_limit","target_count","status","queued_count","running_count","completed_count","failed_count","cancelled_count","result_count","reserved_credits","billed_credits","cancel_requested_at","created_at"],"title":"BatchResponse"},"ExtractionRequest":{"properties":{"platform":{"type":"string","maxLength":30,"minLength":1,"title":"Platform","default":"instagram"},"operation":{"type":"string","enum":["profile","posts","reels","comments","highlights","stories","hashtag","search","post","video","transcript"],"title":"Operation"},"target":{"type":"string","maxLength":255,"minLength":1,"title":"Target"},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","default":12},"include_posts":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Include Posts","default":0}},"additionalProperties":false,"type":"object","required":["operation","target"],"title":"ExtractionRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"JobResponse":{"properties":{"id":{"type":"string","title":"Id"},"platform":{"type":"string","title":"Platform"},"operation":{"type":"string","title":"Operation"},"target":{"type":"string","title":"Target"},"requested_limit":{"type":"integer","title":"Requested Limit"},"include_posts":{"type":"integer","title":"Include Posts","default":0},"status":{"type":"string","title":"Status"},"attempts":{"type":"integer","title":"Attempts"},"max_attempts":{"type":"integer","title":"Max Attempts"},"progress_stage":{"type":"string","title":"Progress Stage"},"progress_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Progress Message"},"progress_current":{"type":"integer","title":"Progress Current"},"progress_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Progress Total"},"heartbeat_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Heartbeat At"},"next_attempt_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Attempt At"},"cancel_requested_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancel Requested At"},"result_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Result Count"},"billed_units":{"type":"integer","title":"Billed Units"},"credit_rate":{"type":"integer","title":"Credit Rate"},"billed_credits":{"type":"integer","title":"Billed Credits"},"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"error":{"anyOf":[{},{"type":"null"}],"title":"Error"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"cached":{"type":"boolean","title":"Cached","default":false},"deduplicated":{"type":"boolean","title":"Deduplicated","default":false},"idempotent_replay":{"type":"boolean","title":"Idempotent Replay","default":false}},"type":"object","required":["id","platform","operation","target","requested_limit","status","attempts","max_attempts","progress_stage","progress_message","progress_current","progress_total","heartbeat_at","next_attempt_at","cancel_requested_at","result_count","billed_units","credit_rate","billed_credits","created_at","started_at","finished_at"],"title":"JobResponse"},"OperationCapabilityResponse":{"properties":{"operation":{"type":"string","title":"Operation"},"max_results":{"type":"integer","title":"Max Results"},"credits_per_result":{"type":"integer","title":"Credits Per Result"},"base_credits":{"type":"integer","title":"Base Credits"},"requires_session":{"type":"boolean","title":"Requires Session"}},"type":"object","required":["operation","max_results","credits_per_result","base_credits","requires_session"],"title":"OperationCapabilityResponse"},"PlatformResponse":{"properties":{"platform":{"type":"string","title":"Platform"},"label":{"type":"string","title":"Label"},"operations":{"items":{"$ref":"#/components/schemas/OperationCapabilityResponse"},"type":"array","title":"Operations"}},"type":"object","required":["platform","label","operations"],"title":"PlatformResponse"},"ScheduleCreateRequest":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"},"platform":{"type":"string","maxLength":30,"minLength":1,"title":"Platform","default":"instagram"},"operation":{"type":"string","enum":["profile","posts","reels","comments","highlights","stories","hashtag","search","post","video","transcript"],"title":"Operation"},"targets":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Targets"},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","default":12},"include_posts":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Include Posts","default":0},"frequency":{"type":"string","enum":["once","daily","weekly","monthly"],"title":"Frequency"},"timezone":{"type":"string","maxLength":64,"minLength":1,"title":"Timezone"},"starts_at":{"type":"string","format":"date-time","title":"Starts At"},"overlap_policy":{"type":"string","const":"skip","title":"Overlap Policy","default":"skip"}},"additionalProperties":false,"type":"object","required":["name","operation","targets","frequency","timezone","starts_at"],"title":"ScheduleCreateRequest","description":"A reusable extraction request and its timezone-aware recurrence."},"ScheduleResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"platform":{"type":"string","title":"Platform"},"operation":{"type":"string","title":"Operation"},"targets":{"items":{"type":"string"},"type":"array","title":"Targets"},"requested_limit":{"type":"integer","title":"Requested Limit"},"include_posts":{"type":"integer","title":"Include Posts"},"frequency":{"type":"string","enum":["once","daily","weekly","monthly"],"title":"Frequency"},"timezone":{"type":"string","title":"Timezone"},"starts_at":{"type":"string","format":"date-time","title":"Starts At"},"next_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Run At"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"status":{"type":"string","title":"Status"},"overlap_policy":{"type":"string","title":"Overlap Policy"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"runs":{"items":{"$ref":"#/components/schemas/ScheduleRunResponse"},"type":"array","title":"Runs"}},"type":"object","required":["id","name","platform","operation","targets","requested_limit","include_posts","frequency","timezone","starts_at","next_run_at","last_run_at","status","overlap_policy","created_at","updated_at"],"title":"ScheduleResponse"},"ScheduleRunResponse":{"properties":{"id":{"type":"string","title":"Id"},"trigger":{"type":"string","title":"Trigger"},"scheduled_for":{"type":"string","format":"date-time","title":"Scheduled For"},"status":{"type":"string","title":"Status"},"job_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Id"},"batch_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Batch Id"},"error":{"anyOf":[{},{"type":"null"}],"title":"Error"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"dispatched_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Dispatched At"}},"type":"object","required":["id","trigger","scheduled_for","status","job_id","batch_id","error","created_at","dispatched_at"],"title":"ScheduleRunResponse"},"ScheduleUpdateRequest":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"},"platform":{"type":"string","maxLength":30,"minLength":1,"title":"Platform","default":"instagram"},"operation":{"type":"string","enum":["profile","posts","reels","comments","highlights","stories","hashtag","search","post","video","transcript"],"title":"Operation"},"targets":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Targets"},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","default":12},"include_posts":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Include Posts","default":0},"frequency":{"type":"string","enum":["once","daily","weekly","monthly"],"title":"Frequency"},"timezone":{"type":"string","maxLength":64,"minLength":1,"title":"Timezone"},"starts_at":{"type":"string","format":"date-time","title":"Starts At"},"overlap_policy":{"type":"string","const":"skip","title":"Overlap Policy","default":"skip"}},"additionalProperties":false,"type":"object","required":["name","operation","targets","frequency","timezone","starts_at"],"title":"ScheduleUpdateRequest"},"UsageResponse":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"credit_limit":{"type":"integer","title":"Credit Limit"},"units_used":{"type":"integer","title":"Units Used"},"units_reserved":{"type":"integer","title":"Units Reserved"},"units_remaining":{"type":"integer","title":"Units Remaining"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_reserved":{"type":"integer","title":"Credits Reserved"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"purchased_credits":{"type":"integer","title":"Purchased Credits"},"promotional_credits":{"type":"integer","title":"Promotional Credits"},"promotional_expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Promotional Expires At"},"lifetime_purchased":{"type":"integer","title":"Lifetime Purchased"},"lifetime_spent":{"type":"integer","title":"Lifetime Spent"}},"type":"object","required":["period_start","credit_limit","units_used","units_reserved","units_remaining","credits_used","credits_reserved","credits_remaining","purchased_credits","promotional_credits","promotional_expires_at","lifetime_purchased","lifetime_spent"],"title":"UsageResponse"},"UserResponse":{"properties":{"id":{"type":"string","title":"Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"}},"type":"object","required":["id","email","display_name","avatar_url"],"title":"UserResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WorkspaceResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"kind":{"type":"string","enum":["personal","team"],"title":"Kind"},"role":{"type":"string","title":"Role"}},"type":"object","required":["id","name","kind","role"],"title":"WorkspaceResponse"}}},"servers":[{"url":"https://api.caelario.com","description":"Production"}],"externalDocs":{"description":"Caelario developer documentation","url":"https://caelario.com/developers"}}