> ## Documentation Index > Fetch the complete documentation index at: https://docs.tinyfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # Plan a dataset schema > The schema the agent would use for a prompt, to review or edit before creating. ## OpenAPI ````yaml https://agent.tinyfish.ai/v1/openapi/datasets post /v1/datasets/plan openapi: 3.0.0 info: title: TinyFish Datasets API version: 1.0.0 description: Describe a dataset in plain English and have agents fill it from the web. contact: name: TinyFish Support email: support@tinyfish.ai servers: - url: https://agent.tinyfish.ai security: [] paths: /v1/datasets/plan: post: summary: Plan a dataset schema description: >- The schema the agent would use for a prompt, to review or edit before creating. operationId: planDataset 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 required: - prompt additionalProperties: false responses: '200': description: The planned schema content: application/json: schema: type: object properties: spec: type: object properties: name: type: string minLength: 1 maxLength: 200 description: type: string minLength: 1 columns: type: array items: type: object properties: name: type: string minLength: 1 label: type: string minLength: 1 maxLength: 200 type: type: string enum: - string - number - boolean - url - date is_primary_key: type: boolean retrieval_hint: type: string maxLength: 2000 required: - name - type - is_primary_key minItems: 1 maxItems: 64 keep_when: type: object properties: column: type: string minLength: 1 required: - column required: - name - description - columns description: >- The schema the agent designed; edit and send to POST /v1/datasets required: - spec '400': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '401': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '403': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '404': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '422': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '429': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '500': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '502': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '503': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format '504': 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 message: type: string description: Human-readable error message example: Field "url" is required and must be a string details: nullable: true description: Additional error details (validation errors, etc.) required: - code - message 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 required: - error description: Standard error response format security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: API key for authentication. Get your key from the API Keys page. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.