{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
API Reference
Plan a dataset schema
The schema the agent would use for a prompt, to review or edit before creating.
POST
/
v1
/
datasets
/
plan
Plan a dataset schema
curl --request POST \ --url https://agent.tinyfish.ai/v1/datasets/plan \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "prompt": "Specialty coffee shops in Oakland with their website and rating"}'
import requests
url = "https://agent.tinyfish.ai/v1/datasets/plan"
payload = { "prompt": "Specialty coffee shops in Oakland with their website and rating" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompt: 'Specialty coffee shops in Oakland with their website and rating'})
};
fetch('https://agent.tinyfish.ai/v1/datasets/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
The schema the agent designed; edit and send to POST /v1/datasets
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TinyFish","colors":{"primary":"#D74B28","light":"#D74B28","dark":"#D74B28"},"logo":{"light":"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_Horizontal.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=3ff7a57ebbe744005f4f984e986f16b9","dark":"https://mintcdn.com/tinyfish/VrMSbq950IKhOmzd/logo/dark.svg?fit=max\u0026auto=format\u0026n=VrMSbq950IKhOmzd\u0026q=85\u0026s=78303ae67f6f601a47cdfd79f978f941","href":"https://agent.tinyfish.ai"},"favicon":"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_ICON.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=9151d20cf17b84686c03e299a8997a32","navbar":{"primary":{"type":"button","label":"Get API Key","href":"https://agent.tinyfish.ai/api-keys"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/tinyfish-ai","x":"https://x.com/Tiny_Fish","discord":"https://discord.gg/tinyfish","youtube":"https://www.youtube.com/@TinyFish-AI"}},"integrations":{"ga4":{"measurementId":"G-P52K96QP6R"},"posthog":{"apiKey":"phc_NJaHVgJntoRghYPq3Q92cniMBBbLRh4cE2S5xX1XVyL"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tinyfish","hasAudioNarration":false,"actualSubdomain":"tinyfish","customDomains":["docs.tinyfish.ai"],"gitSource":{"type":"github","owner":"tinyfish-io","repo":"ux-labs","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3eb4b842f7e61e87b85e9","collectionId":"de305413-fe1a-40ff-a337-74dab5ee8948","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3eb4b842f7e61e87b85e9"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae3efe729c8303331bca381","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":84},{"language":"default","tag":"Documentation","count":54},{"language":"default","tag":"Agent \u0026 Runs","count":28},{"language":"default","tag":"Browser Context Profiles","count":10},{"language":"default","tag":"Datasets","count":9},{"language":"default","tag":"Agent API","count":8},{"language":"default","tag":"Tools \u0026 Integrations","count":8},{"language":"default","tag":"Monitor","count":8},{"language":"default","tag":"Capabilities","count":7},{"language":"default","tag":"Runs","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/plan-a-dataset-schema","slug":"/api-reference/plan-a-dataset-schema","pageMetadata":{"title":"Plan a dataset schema","description":"The schema the agent would use for a prompt, to review or edit before creating.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/plan","href":"/api-reference/plan-a-dataset-schema","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The schema the agent would use for a prompt, to review or edit before creating.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Plan a dataset schema","description":"The schema the agent would use for a prompt, to review or edit before creating.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/plan","href":"/api-reference/plan-a-dataset-schema","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["8f9c4dcb-07f1-4258-be43-d96885880668"],"operationId":"planDataset","summary":"Plan a dataset schema","description":"The schema the agent would use for a prompt, to review or edit before creating.","requestBody":"6ccc4935-429f-4ed2-bc52-fec6fcd297f2","responses":{"200":"8b777787-e9f0-4c50-a3e0-7c75ad8c889f","400":"a68dfa7b-251f-468d-a1c9-bfeed31b5490","401":"e1e8e7ec-d9d5-4959-8a5a-392307293bd8","403":"9b0e0472-d77a-4813-96ec-29a9b8e9e2dd","404":"f019ad10-c458-4095-9a3e-5b0b2196da5a","422":"30b9422e-811b-4850-8075-921cbe2b4330","429":"a3658596-157f-452d-937e-59ef902e07b1","500":"77bca4b9-c362-454e-b044-39bc18508b02","502":"ccb155ff-208b-4136-bf7e-9aaa379de6c4","503":"6692aebe-ac81-43d1-92a9-ecc78e3ba2f6","504":"b5618b77-c0d3-4a02-877a-c2ae571992f4"},"method":"post","type":"path","servers":["a2e10dda-b0c3-4ed6-b786-e5927ceb2e23"],"path":"/v1/datasets/plan","baseUrlOptions":["https://agent.tinyfish.ai"],"title":"Plan a dataset schema","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":3,"maxLength":15000,"description":"What the dataset should contain, in plain English","example":"Specialty coffee shops in Oakland with their website and rating","isRequired":true,"uniqueKey":"prompt","typeLabel":"string"}},"required":["prompt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"prompt":"Specialty coffee shops in Oakland with their website and rating"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8b777787-e9f0-4c50-a3e0-7c75ad8c889f":{"description":"The planned schema","content":{"application/json":{"schema":{"type":"object","properties":{"spec":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"spec.name","typeLabel":"string"},"description":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"spec.description","typeLabel":"string"},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"spec.columns.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["string","number","boolean","url","date"],"isRequired":true,"uniqueKey":"spec.columns.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"is_primary_key":{"type":"boolean","isRequired":true,"uniqueKey":"spec.columns.items.[INDEX].is_primary_key","typeLabel":"boolean"},"label":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"spec.columns.items.[INDEX].label","typeLabel":"string"},"retrieval_hint":{"type":"string","maxLength":2000,"uniqueKey":"spec.columns.items.[INDEX].retrieval_hint","typeLabel":"string"}},"required":["name","type","is_primary_key"],"uniqueKey":"spec.columns.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":64,"isRequired":true,"uniqueKey":"spec.columns","typeLabel":"object[]"},"keep_when":{"type":"object","properties":{"column":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"spec.keep_when.column","typeLabel":"string"}},"required":["column"],"uniqueKey":"spec.keep_when","typeLabel":"object"}},"required":["name","description","columns"],"description":"The schema the agent designed; edit and send to POST /v1/datasets","isRequired":true,"uniqueKey":"spec","typeLabel":"object"}},"required":["spec"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"spec":{"name":"\u003cstring>","description":"\u003cstring>","columns":[{"name":"\u003cstring>","type":"string","is_primary_key":true,"label":"\u003cstring>","retrieval_hint":"\u003cstring>"}],"keep_when":{"column":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a68dfa7b-251f-468d-a1c9-bfeed31b5490":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"e1e8e7ec-d9d5-4959-8a5a-392307293bd8":{"description":"Unauthorized - missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"9b0e0472-d77a-4813-96ec-29a9b8e9e2dd":{"description":"Forbidden - team API keys cannot use Datasets","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"f019ad10-c458-4095-9a3e-5b0b2196da5a":{"description":"Not found - the dataset or run, or the Datasets API for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"30b9422e-811b-4850-8075-921cbe2b4330":{"description":"The agent could not design a schema for the prompt","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"a3658596-157f-452d-937e-59ef902e07b1":{"description":"Rate limit or daily run limit exceeded","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"77bca4b9-c362-454e-b044-39bc18508b02":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"ccb155ff-208b-4136-bf7e-9aaa379de6c4":{"description":"Datasets service gave a bad answer; retry","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"6692aebe-ac81-43d1-92a9-ecc78e3ba2f6":{"description":"Datasets service unavailable; retry","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"b5618b77-c0d3-4a02-877a-c2ae571992f4":{"description":"Planning the schema timed out","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8f9c4dcb-07f1-4258-be43-d96885880668":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the API Keys page.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"a2e10dda-b0c3-4ed6-b786-e5927ceb2e23":{"url":"https://agent.tinyfish.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the API Keys page.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Get your key from the API Keys page.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://agent.tinyfish.ai/v1/openapi/datasets"},"subdomain":"tinyfish","siteName":"TinyFish","title":"Plan a dataset schema - TinyFish","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T00:31:20.879Z","originalFileLocation":"api-reference/plan-a-dataset-schema.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The schema the agent would use for a prompt, to review or edit before creating.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TinyFish\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Plan a dataset schema - TinyFish\">\u003cmeta data-mint-head property=\"og:description\" content=\"The schema the agent would use for a prompt, to review or edit before creating.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TinyFish\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tinyfish.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Plan+a+dataset+schema\u0026amp;description=The+schema+the+agent+would+use+for+a+prompt%2C+to+review+or+edit+before+creating.\u0026amp;theme=619f6727a66ef17f9efad127\u0026amp;signature=76e22e2c051cf18ec9e51f928b77c31b6576d714130061ab01fa09c7a2184380\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Plan a dataset schema - TinyFish\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The schema the agent would use for a prompt, to review or edit before creating.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tinyfish.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Plan+a+dataset+schema\u0026amp;description=The+schema+the+agent+would+use+for+a+prompt%2C+to+review+or+edit+before+creating.\u0026amp;theme=619f6727a66ef17f9efad127\u0026amp;signature=76e22e2c051cf18ec9e51f928b77c31b6576d714130061ab01fa09c7a2184380\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TinyFish\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D74B28\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/plan-a-dataset-schema.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tinyfish.ai/#organization\",\"name\":\"TinyFish\",\"url\":\"https://docs.tinyfish.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_Horizontal.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=3ff7a57ebbe744005f4f984e986f16b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tinyfish.ai#website\",\"name\":\"TinyFish\",\"url\":\"https://docs.tinyfish.ai\",\"publisher\":{\"@id\":\"https://docs.tinyfish.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema#webpage\",\"url\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema\",\"name\":\"Plan a dataset schema\",\"description\":\"The schema the agent would use for a prompt, to review or edit before creating.\",\"dateModified\":\"2026-10-30T00:31:20.879Z\",\"isPartOf\":{\"@id\":\"https://docs.tinyfish.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Datasets\",\"item\":\"https://docs.tinyfish.ai/api-reference/list-datasets\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.tinyfish.ai/api-reference/list-datasets\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Plan a dataset schema\",\"item\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema#apireference\",\"headline\":\"Plan a dataset schema\",\"name\":\"Plan a dataset schema\",\"description\":\"The schema the agent would use for a prompt, to review or edit before creating.\",\"url\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tinyfish.ai/api-reference/plan-a-dataset-schema#webpage\"},\"dateModified\":\"2026-10-30T00:31:20.879Z\",\"publisher\":{\"@id\":\"https://docs.tinyfish.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tinyfish.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TinyFish\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TinyFish","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Agent \u0026 Runs","icon":"sparkles","pages":[{"group":"Automation","pages":[{"title":"Run browser automation with SSE streaming","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-sse","href":"/api-reference/automation/run-browser-automation-with-sse-streaming"},{"title":"Run browser automation synchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run","href":"/api-reference/automation/run-browser-automation-synchronously"},{"title":"Start automation asynchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-async","href":"/api-reference/automation/start-automation-asynchronously"},{"title":"Start multiple automations asynchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-batch","href":"/api-reference/automation/start-multiple-automations-asynchronously"}]},{"group":"Runs","pages":[{"title":"List and search runs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs","href":"/api-reference/runs/list-and-search-runs"},{"title":"Get multiple runs by IDs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/batch","href":"/api-reference/runs/get-multiple-runs-by-ids"},{"title":"Cancel multiple runs by IDs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/batch/cancel","href":"/api-reference/runs/cancel-multiple-runs-by-ids"},{"title":"Get run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}","href":"/api-reference/runs/get-run-by-id"},{"title":"Cancel run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/{id}/cancel","href":"/api-reference/runs/cancel-run-by-id"},{"title":"Get step screenshot","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}/steps/{stepId}/screenshot","href":"/api-reference/runs/get-step-screenshot"},{"title":"Get step HTML snapshot","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}/steps/{stepId}/html","href":"/api-reference/runs/get-step-html-snapshot"}]},{"group":"Browser Context Profiles","pages":[{"title":"List Browser Context Profiles","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/profiles","href":"/api-reference/browser-context-profiles/list-browser-context-profiles"},{"title":"Create a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles","href":"/api-reference/browser-context-profiles/create-a-browser-context-profile"},{"title":"Get a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/get-a-browser-context-profile"},{"title":"Delete a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/delete-a-browser-context-profile"},{"title":"Update a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main patch /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/update-a-browser-context-profile"},{"title":"Create a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/setup-session","href":"/api-reference/browser-context-profiles/create-a-profile-setup-session"},{"title":"Cancel a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/setup-session/cancel","href":"/api-reference/browser-context-profiles/cancel-a-profile-setup-session"},{"title":"Save a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/save","href":"/api-reference/browser-context-profiles/save-a-profile-setup-session"},{"title":"Upload Browser Context Profile state","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/upload","href":"/api-reference/browser-context-profiles/upload-browser-context-profile-state"},{"title":"Delete a saved profile domain","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/profiles/{profileId}/domains/{domain}","href":"/api-reference/browser-context-profiles/delete-a-saved-profile-domain"}]},{"group":"Vault","pages":[{"title":"List vault connections","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/vault/connections","href":"/api-reference/vault/list-vault-connections"},{"title":"Connect a vault provider","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/vault/connections","href":"/api-reference/vault/connect-a-vault-provider"},{"title":"Disconnect a vault provider","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/vault/connections/{connectionId}","href":"/api-reference/vault/disconnect-a-vault-provider"},{"title":"List vault items","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/vault/items","href":"/api-reference/vault/list-vault-items"},{"title":"Sync vault items","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/vault/items/sync","href":"/api-reference/vault/sync-vault-items"}]},{"group":"Wallet","pages":[{"title":"Get wallet","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/wallet","href":"/api-reference/wallet/get-wallet"},{"title":"Top up wallet (agent-paid)","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/wallet/top-up","href":"/api-reference/wallet/top-up-wallet-agent-paid"}]}]},{"group":"Research","icon":"telescope","pages":[{"group":"API Reference","pages":[{"title":"Run research with SSE streaming","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research","href":"/api-reference/run-research-with-sse-streaming"},{"title":"Start research asynchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research-async","href":"/api-reference/start-research-asynchronously"},{"title":"Attach to research progress","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run/{research_run_id}/events","href":"/api-reference/attach-to-research-progress"},{"title":"List research runs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run","href":"/api-reference/list-research-runs"},{"title":"Get research run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run/{research_run_id}","href":"/api-reference/get-research-run-by-id"},{"title":"Cancel research run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/research-run/{research_run_id}/cancel","href":"/api-reference/cancel-research-run-by-id"}]}]},{"group":"Fetch","icon":"bolt","pages":[{"group":"API Reference","pages":[{"title":"Fetch and extract content from URLs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/fetch post /","href":"/api-reference/fetch-and-extract-content-from-urls"},{"title":"List fetch usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/fetch get /usage","href":"/api-reference/list-fetch-usage"}]}]},{"group":"Search","icon":"magnifying-glass","pages":[{"group":"API Reference","pages":[{"title":"Search the web","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/search get /","href":"/api-reference/search-the-web"},{"title":"List search usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/search get /usage","href":"/api-reference/list-search-usage"}]}]},{"group":"Browser","icon":"browser","pages":[{"group":"API Reference","pages":[{"title":"Create a remote browser session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser post /","href":"/api-reference/create-a-remote-browser-session"},{"title":"List browser session usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser get /usage","href":"/api-reference/list-browser-session-usage"},{"title":"Terminate a browser session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser delete /{sessionId}","href":"/api-reference/terminate-a-browser-session"}]}]},{"group":"Monitor","icon":"eye","pages":[{"group":"API Reference","pages":[{"title":"List Monitors","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor get /v1/monitors","href":"/api-reference/list-monitors"},{"title":"Create a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor post /v1/monitors","href":"/api-reference/create-a-monitor"},{"title":"Get a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor get /v1/monitors/{id}","href":"/api-reference/get-a-monitor"},{"title":"Delete a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor delete /v1/monitors/{id}","href":"/api-reference/delete-a-monitor"},{"title":"Update a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor patch /v1/monitors/{id}","href":"/api-reference/update-a-monitor"},{"title":"Run a Monitor now","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor post /v1/monitors/{id}/runs","href":"/api-reference/run-a-monitor-now"}]}]},{"group":"Datasets","icon":"table","pages":[{"group":"API Reference","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets get /v1/datasets","href":"/api-reference/list-datasets"},{"title":"Create a dataset","description":"Describe the dataset in a prompt, or send a spec from /v1/datasets/plan. The dataset starts filling in the background; poll GET /v1/datasets/{id} and stop once status is no longer populating: ready, empty (no rows landed), failed or cancelled, with `run.status` and `run.error` saying how the fill ended. Or follow the run at /runs/{runId}/events.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets","href":"/api-reference/create-a-dataset"},{"title":"Plan a dataset schema","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/plan","href":"/api-reference/plan-a-dataset-schema"},{"title":"Get a dataset","description":null,"deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets get /v1/datasets/{id}","href":"/api-reference/get-a-dataset"},{"title":"Delete a dataset","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets delete /v1/datasets/{id}","href":"/api-reference/delete-a-dataset"},{"title":"Get rows","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets get /v1/datasets/{id}/rows","href":"/api-reference/get-rows"},{"title":"Populate a dataset","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/{id}/populate","href":"/api-reference/populate-a-dataset"},{"title":"Cancel a run","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/{id}/runs/{runId}/cancel","href":"/api-reference/cancel-a-run"},{"title":"Follow a run","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/datasets get /v1/datasets/{id}/runs/{runId}/events","href":"/api-reference/follow-a-run"}]}]}]},{"tab":"Cookbook","icon":"utensils","href":"https://github.com/tinyfish-io/tinyfish-cookbook"}]},"title":"Plan a dataset schema - TinyFish","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}