{"openapi":"3.1.0","paths":{"/v1/credits/balance":{"get":{"description":"The `/credits/balance` endpoint allows you to retrieve your current credits balance.","operationId":"balance","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditOutput_Output"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}},"security":[{"bearer":[]}],"summary":"/credits/balance","tags":["Credits"]}},"/v1/fetch":{"post":{"description":"The `/fetch` endpoint allows you to fetch a single webpage from a given URL.","operationId":"fetch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchInput"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchOutput_Output"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"},"402":{"description":"Payment Required - No API key provided. Returns x402 payment details in the `payment-required` header for pay-per-request with USDC."},"429":{"description":"Too Many Requests - Rate limit exceeded or insufficient credits"}},"security":[{"bearer":[]}],"summary":"/fetch","tags":["Fetch"]}},"/v1/search":{"post":{"description":"The `/search` endpoint allows you to retrieve web content.","operationId":"search","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchInput"}}}},"responses":{"200":{"content":{"searchResults":{"schema":{"$ref":"#/components/schemas/SearchResultsOutput"}},"sourcedAnswer":{"schema":{"$ref":"#/components/schemas/SourcedAnswerOutput"}},"structured":{"schema":{"description":"When you pick `structured` for the `outputType` parameter, you will get the object corresponding to the JSON schema you used in the `structuredOutputSchema` param.","properties":{},"type":"object"}},"structuredWithSources":{"schema":{"$ref":"#/components/schemas/StructuredWithSourcesOutput"}}},"description":"Successful response"},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"},"402":{"description":"Payment Required - No API key provided. Returns x402 payment details in the `payment-required` header for pay-per-request with USDC."},"429":{"description":"Too Many Requests - Rate limit exceeded or insufficient credits"}},"security":[{"bearer":[]}],"summary":"/search","tags":["Search"]}},"/v1/tasks":{"post":{"description":"The `POST /tasks` method creates a list of tasks.","operationId":"createTasks","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksInput"}}}},"responses":{"200":{"description":"Tasks created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostTasksOutput_Output"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"},"429":{"description":"Too Many Requests - Rate limit exceeded or insufficient credits"}},"security":[{"bearer":[]}],"summary":"/tasks","tags":["Tasks"]},"get":{"description":"The `GET /tasks` method, without a task identifier, lists all created tasks for the authenticated organization, with pagination.","operationId":"listTasks","parameters":[{"name":"type","required":false,"in":"query","explode":true,"schema":{"enum":["fetch","research","search"],"type":"string"}},{"name":"status","required":false,"in":"query","explode":true,"schema":{"enum":["completed","failed","pending","processing"],"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"default":1,"minimum":1,"type":"integer"}},{"name":"pageSize","required":false,"in":"query","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}},{"name":"sortBy","required":false,"in":"query","schema":{"enum":["createdAt","updatedAt"],"type":"string"}},{"name":"sortDirection","required":false,"in":"query","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"description":"Paginated list of tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTasksOutput"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}},"security":[{"bearer":[]}],"summary":"/tasks","tags":["Tasks"]}},"/v1/tasks/{id}":{"get":{"description":"The `GET /tasks/:id` method, with task identifier, retrieves a specific task information.","operationId":"getTask","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Task details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskOutput"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"}},"security":[{"bearer":[]}],"summary":"/tasks/:id","tags":["Tasks"]}},"/v1/responses":{"post":{"description":"Proxy endpoint for OpenAI response generation — use when the OpenAI client's base URL is set to linkup.","operationId":"responses","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponsesInput"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsesOutput_Output"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"},"429":{"description":"Too Many Requests - Rate limit exceeded or insufficient credits"}},"security":[{"bearer":[]}],"summary":"/responses","tags":["Responses"]}},"/v1/research":{"post":{"description":"The `POST /research` method creates an asynchronous research task which can perform a comprehensive web research. **This endpoint is currently in beta, it might be subject to changes.**","operationId":"createResearch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostResearchInput"}}}},"responses":{"200":{"description":"Research task created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostResearchOutput_Output"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"},"402":{"description":"Payment Required - No API key provided. Returns x402 payment details in the `payment-required` header for pay-per-request with USDC."},"429":{"description":"Too Many Requests - Rate limit exceeded or insufficient credits"}},"security":[{"bearer":[]}],"summary":"/research","tags":["Research"]},"get":{"description":"The `GET /research` method, without research task identifier, lists all created research tasks for the authenticated organization, with pagination. **This endpoint is currently in beta, it might be subject to changes.**","operationId":"listResearch","parameters":[{"name":"page","required":false,"in":"query","schema":{"default":1,"minimum":1,"type":"integer"}},{"name":"pageSize","required":false,"in":"query","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}},{"name":"sortBy","required":false,"in":"query","schema":{"enum":["createdAt","updatedAt"],"type":"string"}},{"name":"sortDirection","required":false,"in":"query","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"description":"Paginated list of research tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResearchOutput"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}},"security":[{"bearer":[]}],"summary":"/research","tags":["Research"]}},"/v1/research/{id}":{"get":{"description":"The `GET /research/:id` method, with research task identifier, retrieves a specific research task information. **This endpoint is currently in beta, it might be subject to changes.**","operationId":"getResearch","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Research task details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchTaskOutput"}}}},"400":{"description":"Bad Request - Invalid parameters"},"401":{"description":"Unauthorized - Invalid or missing API key"}},"security":[{"bearer":[]}],"summary":"/research/:id","tags":["Research"]}}},"info":{"title":"Linkup API","description":"Search the web in real time to get trustworthy, source-backed answers. Find the latest news and comprehensive results from the most relevant sources. Use natural language queries to quickly gather facts, citations, and context.","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"https://api.linkup.so"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreditOutput_Output":{"type":"object","properties":{"balance":{"type":"number","description":"The number of credits remaining in your account.","example":123.456}},"required":["balance"],"id":"CreditOutput_Output","additionalProperties":false},"FetchImageOutput":{"type":"object","properties":{"alt":{"description":"The alt text of the image.","example":"Image description","type":"string"},"url":{"type":"string","description":"The URL of the image.","example":"https://example.com/image.jpg","format":"uri"}},"required":["url"],"id":"FetchImageOutput"},"FetchInput":{"type":"object","properties":{"extractImages":{"default":false,"description":"Defines whether the API should extract the images from the webpage in its response.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"includeRawHtml":{"default":false,"description":"Defines whether the API should include the raw HTML of the webpage in its response.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"renderJs":{"default":false,"description":"Defines whether the API should render the JavaScript of the webpage.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"url":{"description":"The URL of the webpage you want to fetch.","example":"https://docs.linkup.so","format":"uri","type":"string"}},"required":["url"],"id":"FetchInput"},"FetchImageOutput_Output":{"type":"object","properties":{"alt":{"description":"The alt text of the image.","example":"Image description","type":"string"},"url":{"type":"string","description":"The URL of the image.","example":"https://example.com/image.jpg","format":"uri"}},"required":["url"],"additionalProperties":false,"id":"FetchImageOutput_Output"},"FetchOutput_Output":{"type":"object","properties":{"images":{"description":"List of images extracted from the webpage.","example":[{"alt":"Image 1","url":"https://example.com/image.jpg"},{"alt":"Image 2","url":"https://example.com/image2.jpg"}],"type":"array","items":{"$ref":"#/components/schemas/FetchImageOutput_Output"}},"markdown":{"type":"string","description":"The clean markdown version of the webpage.","example":"Get started for free, no credit card required..."},"rawHtml":{"description":"The raw HTML version of the webpage.","example":"<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>","type":"string"}},"required":["markdown"],"additionalProperties":false,"id":"FetchOutput_Output"},"Source":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"favicon":{"description":"The favicon URL, if available.","example":"https://www.microsoft.com/favicon.ico","format":"uri","anyOf":[{"type":"string","const":""},{"type":"string","format":"uri"},{"type":"null"}]},"snippet":{"type":"string","description":"Extracted text content associated with the source.","example":"Highlights from fiscal year 2024 compared with fiscal year 2023 included..."}},"required":["name","url","snippet"],"id":"Source"},"SourcedAnswerOutput":{"type":"object","properties":{"answer":{"type":"string","description":"The answer to your question.","example":"Microsoft's revenue for fiscal year 2024 was $245.1 billion, reflecting a 16% increase from the previous year."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source"},"description":"List of sources used to answer the question.","example":[{"name":"Microsoft 2024 Annual Report","snippet":"Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion.","url":"https://www.microsoft.com/investor/reports/ar24/index.html"}]}},"required":["answer","sources"],"id":"SourcedAnswerOutput"},"TextSearchResultOutput":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"content":{"type":"string","description":"Extracted text content associated with the resource.","example":"Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion."},"favicon":{"description":"The favicon URL, if available.","example":"https://www.microsoft.com/favicon.ico","format":"uri","anyOf":[{"type":"string","const":""},{"type":"string","format":"uri"},{"type":"null"}]},"type":{"type":"string","const":"text","description":"The type of the resource.","enum":["text"],"example":"text"}},"required":["name","url","content","type"],"id":"TextSearchResultOutput"},"ImageSearchResultOutput":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"type":{"type":"string","const":"image","description":"The type of the resource.","enum":["image"],"example":"image"}},"required":["name","url","type"],"id":"ImageSearchResultOutput"},"SearchResultsOutput":{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TextSearchResultOutput"},{"$ref":"#/components/schemas/ImageSearchResultOutput"}]},"description":"List of search results."}},"required":["results"],"id":"SearchResultsOutput"},"SearchOutput":{"type":"object","properties":{},"additionalProperties":{},"id":"SearchOutput"},"StructuredWithSourcesOutput":{"type":"object","properties":{"data":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":true,"description":"The object corresponding to the JSON schema you used in the `structuredOutputSchema` param."},"sources":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TextSearchResultOutput"},{"$ref":"#/components/schemas/ImageSearchResultOutput"}]},"description":"List of sources used to answer the question."}},"required":["data","sources"],"id":"StructuredWithSourcesOutput"},"SearchInput":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","anyOf":[{"type":"boolean"},{"type":"string"}]},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema (as a string) representing the desired response format. The root must be of type `object`."},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"depth":{"type":"string","enum":["deep","fast","standard"],"description":"Defines the precision of the search. [BETA] `fast` is a sub-second search mode optimized for simple, focused queries; `standard` leverages agentic search to handle broader queries spanning multiple topics or sources, while remaining fast; `deep` leverages several iterations of agentic search to return comprehensive results, optimizing for coverage."},"includeInlineCitations":{"default":false,"description":"Relevant only when `outputType` is `sourcedAnswer`. Defines whether the answer should include inline citations.","anyOf":[{"type":"boolean"},{"type":"string"}]},"includeSources":{"default":false,"description":"Relevant only when `outputType` is `structured`. Defines whether the response should include sources. **Please note that it modifies the schema of the response, see below**","anyOf":[{"type":"boolean"},{"type":"string"}]},"maxResults":{"description":"The maximum number of results to return. The number of results will always be ≤ to maxResults.","example":5,"type":"number","minimum":1},"outputType":{"type":"string","enum":["searchResults","sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."}},"required":["q","depth","outputType"],"id":"SearchInput","example":{"depth":"deep","excludeDomains":["wikipedia.org"],"includeDomains":["microsoft.com","agolution.com"],"outputType":"sourcedAnswer","q":"What is Microsoft's 2024 revenue?"}},"FetchOutput":{"type":"object","properties":{"images":{"description":"List of images extracted from the webpage.","example":[{"alt":"Image 1","url":"https://example.com/image.jpg"},{"alt":"Image 2","url":"https://example.com/image2.jpg"}],"type":"array","items":{"$ref":"#/components/schemas/FetchImageOutput"}},"markdown":{"type":"string","description":"The clean markdown version of the webpage.","example":"Get started for free, no credit card required..."},"rawHtml":{"description":"The raw HTML version of the webpage.","example":"<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>","type":"string"}},"required":["markdown"],"id":"FetchOutput"},"TaskInput":{"oneOf":[{"type":"object","properties":{"input":{"$ref":"#/components/schemas/SearchTaskInput"},"type":{"type":"string","const":"search"}},"required":["input","type"]},{"type":"object","properties":{"input":{"$ref":"#/components/schemas/FetchTaskInput"},"type":{"type":"string","const":"fetch"}},"required":["input","type"]},{"type":"object","properties":{"input":{"$ref":"#/components/schemas/ResearchTaskInput"},"type":{"type":"string","const":"research"}},"required":["input","type"]}],"id":"TaskInput"},"SearchTaskInput":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","anyOf":[{"type":"boolean"},{"type":"string"}]},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema (as a string) representing the desired response format. The root must be of type `object`."},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"depth":{"type":"string","enum":["deep","fast","standard"],"description":"Defines the precision of the search. [BETA] `fast` is a sub-second search mode optimized for simple, focused queries; `standard` leverages agentic search to handle broader queries spanning multiple topics or sources, while remaining fast; `deep` leverages several iterations of agentic search to return comprehensive results, optimizing for coverage."},"includeInlineCitations":{"default":false,"description":"Relevant only when `outputType` is `sourcedAnswer`. Defines whether the answer should include inline citations.","anyOf":[{"type":"boolean"},{"type":"string"}]},"includeSources":{"default":false,"description":"Relevant only when `outputType` is `structured`. Defines whether the response should include sources. **Please note that it modifies the schema of the response, see below**","anyOf":[{"type":"boolean"},{"type":"string"}]},"maxResults":{"description":"The maximum number of results to return. The number of results will always be ≤ to maxResults.","example":5,"type":"number","minimum":1},"outputType":{"type":"string","enum":["searchResults","sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."}},"required":["q","depth","outputType"],"id":"SearchTaskInput"},"FetchTaskInput":{"type":"object","properties":{"extractImages":{"default":false,"description":"Defines whether the API should extract the images from the webpage in its response.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"includeRawHtml":{"default":false,"description":"Defines whether the API should include the raw HTML of the webpage in its response.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"renderJs":{"default":false,"description":"Defines whether the API should render the JavaScript of the webpage.","example":false,"anyOf":[{"type":"boolean"},{"type":"string"}]},"url":{"description":"The URL of the webpage you want to fetch.","example":"https://docs.linkup.so","format":"uri","type":"string"}},"required":["url"],"id":"FetchTaskInput"},"ResearchTaskInput":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","anyOf":[{"type":"boolean"},{"type":"string"}]},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema (as a string) representing the desired response format. The root must be of type `object`."},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"mode":{"default":"Auto","description":"Pin the research agent mode. Omit to let the agent auto-classify per request based on the question.","enum":["Answer","Auto","Investigate","Research"],"type":"string"},"outputType":{"type":"string","enum":["sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."},"reasoningDepth":{"default":"L","description":"Pin the reasoning depth (S < M < L < XL). Defaults to L when omitted. Higher depths trade latency for thoroughness.","enum":["L","M","S","XL"],"type":"string"}},"required":["q","outputType"],"id":"ResearchTaskInput"},"TasksInput":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TaskInput"},"example":[{"input":{"depth":"deep","excludeDomains":["wikipedia.org"],"includeDomains":["microsoft.com","agolution.com"],"outputType":"sourcedAnswer","q":"What is Microsoft's 2024 revenue?"},"type":"search"},{"input":{"extractImages":false,"includeRawHtml":false,"renderJs":false,"url":"https://docs.linkup.so"},"type":"fetch"},{"input":{"excludeDomains":["wikipedia.org"],"includeDomains":["microsoft.com","agolution.com"],"includeImages":true,"outputType":"sourcedAnswer","q":"What is Microsoft's 2024 revenue?"},"type":"research"}],"id":"TasksInput"},"TaskOutput_Output":{"oneOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/SearchTaskInput_Output"},"output":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/SourcedAnswerOutput_Output"},{"$ref":"#/components/schemas/SearchResultsOutput_Output"},{"$ref":"#/components/schemas/StructuredWithSourcesOutput_Output"},{"$ref":"#/components/schemas/StructuredOutput_Output"}]},{"type":"null"}]},"type":{"type":"string","const":"search"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"],"additionalProperties":false},{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/FetchTaskInput_Output"},"output":{"anyOf":[{"$ref":"#/components/schemas/FetchOutput_Output"},{"type":"null"}]},"type":{"type":"string","const":"fetch"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchTaskOutput_Output"}],"id":"TaskOutput_Output"},"SearchTaskInput_Output":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","type":"boolean"},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema object representing the desired response format. The root must be of type `object`.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"depth":{"type":"string","enum":["deep","fast","standard"],"description":"Defines the precision of the search. [BETA] `fast` is a sub-second search mode optimized for simple, focused queries; `standard` leverages agentic search to handle broader queries spanning multiple topics or sources, while remaining fast; `deep` leverages several iterations of agentic search to return comprehensive results, optimizing for coverage."},"includeInlineCitations":{"default":false,"description":"Relevant only when `outputType` is `sourcedAnswer`. Defines whether the answer should include inline citations.","type":"boolean"},"includeSources":{"default":false,"description":"Relevant only when `outputType` is `structured`. Defines whether the response should include sources. **Please note that it modifies the schema of the response, see below**","type":"boolean"},"maxResults":{"description":"The maximum number of results to return. The number of results will always be ≤ to maxResults.","example":5,"type":"number","minimum":1},"outputType":{"type":"string","enum":["searchResults","sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."}},"required":["includeImages","q","toDate","depth","includeInlineCitations","includeSources","outputType"],"additionalProperties":false,"id":"SearchTaskInput_Output"},"SourcedAnswerOutput_Output":{"type":"object","properties":{"answer":{"type":"string","description":"The answer to your question.","example":"Microsoft's revenue for fiscal year 2024 was $245.1 billion, reflecting a 16% increase from the previous year."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source_Output"},"description":"List of sources used to answer the question.","example":[{"name":"Microsoft 2024 Annual Report","snippet":"Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion.","url":"https://www.microsoft.com/investor/reports/ar24/index.html"}]}},"required":["answer","sources"],"additionalProperties":false,"id":"SourcedAnswerOutput_Output"},"Source_Output":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"favicon":{"description":"The favicon URL, if available.","example":"https://www.microsoft.com/favicon.ico","format":"uri","anyOf":[{"type":"string","const":""},{"type":"string","format":"uri"},{"type":"null"}]},"snippet":{"type":"string","description":"Extracted text content associated with the source.","example":"Highlights from fiscal year 2024 compared with fiscal year 2023 included..."}},"required":["name","url","snippet"],"additionalProperties":false,"id":"Source_Output"},"SearchResultsOutput_Output":{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TextSearchResultOutput_Output"},{"$ref":"#/components/schemas/ImageSearchResultOutput_Output"}]},"description":"List of search results."}},"required":["results"],"additionalProperties":false,"id":"SearchResultsOutput_Output"},"TextSearchResultOutput_Output":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"content":{"type":"string","description":"Extracted text content associated with the resource.","example":"Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion."},"favicon":{"description":"The favicon URL, if available.","example":"https://www.microsoft.com/favicon.ico","format":"uri","anyOf":[{"type":"string","const":""},{"type":"string","format":"uri"},{"type":"null"}]},"type":{"type":"string","const":"text","description":"The type of the resource.","enum":["text"],"example":"text"}},"required":["name","url","content","type"],"additionalProperties":false,"id":"TextSearchResultOutput_Output"},"ImageSearchResultOutput_Output":{"type":"object","properties":{"name":{"type":"string","description":"The title or name of the resource.","example":"Microsoft 2024 Annual Report"},"url":{"description":"The URL of the resource.","example":"https://www.microsoft.com/investor/reports/ar24/index.html","format":"uri","type":"string"},"type":{"type":"string","const":"image","description":"The type of the resource.","enum":["image"],"example":"image"}},"required":["name","url","type"],"additionalProperties":false,"id":"ImageSearchResultOutput_Output"},"StructuredWithSourcesOutput_Output":{"type":"object","properties":{"data":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":true,"description":"The object corresponding to the JSON schema you used in the `structuredOutputSchema` param."},"sources":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TextSearchResultOutput_Output"},{"$ref":"#/components/schemas/ImageSearchResultOutput_Output"}]},"description":"List of sources used to answer the question."}},"required":["data","sources"],"additionalProperties":false,"id":"StructuredWithSourcesOutput_Output"},"StructuredOutput_Output":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"id":"StructuredOutput_Output"},"FetchTaskInput_Output":{"type":"object","properties":{"extractImages":{"default":false,"description":"Defines whether the API should extract the images from the webpage in its response.","example":false,"type":"boolean"},"includeRawHtml":{"default":false,"description":"Defines whether the API should include the raw HTML of the webpage in its response.","example":false,"type":"boolean"},"renderJs":{"default":false,"description":"Defines whether the API should render the JavaScript of the webpage.","example":false,"type":"boolean"},"url":{"description":"The URL of the webpage you want to fetch.","example":"https://docs.linkup.so","format":"uri","type":"string"}},"required":["extractImages","includeRawHtml","renderJs","url"],"additionalProperties":false,"id":"FetchTaskInput_Output"},"ResearchTaskOutput_Output":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/ResearchTaskInput_Output"},"output":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/SourcedAnswerOutput_Output"},{"$ref":"#/components/schemas/StructuredOutput_Output"}]},{"type":"null"}]},"type":{"type":"string","const":"research"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"],"additionalProperties":false,"id":"ResearchTaskOutput_Output"},"ResearchTaskInput_Output":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","type":"boolean"},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema object representing the desired response format. The root must be of type `object`.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"mode":{"default":"Auto","description":"Pin the research agent mode. Omit to let the agent auto-classify per request based on the question.","enum":["Answer","Auto","Investigate","Research"],"type":"string"},"outputType":{"type":"string","enum":["sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."},"reasoningDepth":{"default":"L","description":"Pin the reasoning depth (S < M < L < XL). Defaults to L when omitted. Higher depths trade latency for thoroughness.","enum":["L","M","S","XL"],"type":"string"}},"required":["includeImages","q","toDate","mode","outputType","reasoningDepth"],"additionalProperties":false,"id":"ResearchTaskInput_Output"},"PostTasksOutput_Output":{"type":"array","items":{"$ref":"#/components/schemas/TaskOutput_Output"},"id":"PostTasksOutput_Output"},"TaskOutput":{"oneOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/SearchTaskInput"},"output":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/SourcedAnswerOutput"},{"$ref":"#/components/schemas/SearchResultsOutput"},{"$ref":"#/components/schemas/StructuredWithSourcesOutput"},{"$ref":"#/components/schemas/StructuredOutput"}]},{"type":"null"}]},"type":{"type":"string","const":"search"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"]},{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/FetchTaskInput"},"output":{"anyOf":[{"$ref":"#/components/schemas/FetchOutput"},{"type":"null"}]},"type":{"type":"string","const":"fetch"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"]},{"$ref":"#/components/schemas/ResearchTaskOutput"}],"id":"TaskOutput"},"StructuredOutput":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"id":"StructuredOutput"},"ResearchTaskOutput":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task was created.","example":"2026-01-01T00:00:00.000Z"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The error message if the task failed."},"id":{"type":"string","description":"The unique identifier of the task.","example":"01234-abcd-56789"},"status":{"type":"string","enum":["completed","failed","pending","processing"],"description":"The current status of the task.","example":"completed"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the task status was last updated.","example":"2026-01-01T00:00:00.000Z"},"input":{"$ref":"#/components/schemas/ResearchTaskInput"},"output":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/SourcedAnswerOutput"},{"$ref":"#/components/schemas/StructuredOutput"}]},{"type":"null"}]},"type":{"type":"string","const":"research"}},"required":["createdAt","error","id","status","updatedAt","input","output","type"],"id":"ResearchTaskOutput"},"TasksQuota":{"type":"object","properties":{"inFlight":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of tasks currently pending or processing for the organization."},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Maximum number of concurrent pending or processing tasks allowed."}},"required":["inFlight","limit"],"id":"TasksQuota"},"ListTasksOutput":{"type":"object","properties":{"metadata":{"type":"object","properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"total":{"type":"number"},"totalPages":{"type":"number"}},"required":["page","pageSize","total","totalPages"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskOutput"}},"quota":{"$ref":"#/components/schemas/TasksQuota"}},"required":["metadata","data","quota"],"id":"ListTasksOutput"},"ResponsesTextFormatInput":{"type":"object","properties":{"format":{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}],"description":"Defines the response text format. Accepts the literal string `text` for plain text or a JSON schema object that describes the desired structured output.","example":"text"}},"required":["format"],"id":"ResponsesTextFormatInput"},"CreateResponsesInput":{"type":"object","properties":{"input":{"anyOf":[{"type":"string"},{"minItems":1,"type":"array","items":{"type":"object","properties":{"content":{"type":"string"},"role":{"type":"string","enum":["user","assistant","developer"]}},"required":["content","role"]}}],"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?"},"instructions":{"description":"Optional instructions to guide the response generation. It`s similar to a system message.","example":"You are a helpful assistant that provides concise answers.","type":"string"},"model":{"type":"string","enum":["linkup-deep","linkup-standard"],"description":"The model used to generate the response.`linkup-standard` returns results faster; `linkup-deep` takes longer but yields more comprehensive results."},"text":{"description":"Optional custom text format configuration.","$ref":"#/components/schemas/ResponsesTextFormatInput"}},"required":["input","model"],"id":"CreateResponsesInput"},"ResponsesMessageOutput_Output":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ResponsesTextOutput_Output"}},"id":{"type":"string"},"role":{"type":"string","const":"assistant"},"status":{"type":"string","const":"completed"},"type":{"type":"string","const":"message"}},"required":["content","id","role","status","type"],"additionalProperties":false,"id":"ResponsesMessageOutput_Output"},"ResponsesTextOutput_Output":{"type":"object","properties":{"annotations":{"type":"array","items":{"$ref":"#/components/schemas/ResponsesUrlCitationOutput_Output"}},"text":{"type":"string"},"type":{"type":"string","const":"output_text"}},"required":["annotations","text","type"],"additionalProperties":false,"id":"ResponsesTextOutput_Output"},"ResponsesUrlCitationOutput_Output":{"type":"object","properties":{"end_index":{"type":"number"},"start_index":{"type":"number"},"title":{"type":"string"},"type":{"type":"string","const":"url_citation"},"url":{"type":"string"}},"required":["end_index","start_index","title","type","url"],"additionalProperties":false,"id":"ResponsesUrlCitationOutput_Output"},"ResponsesOutput_Output":{"type":"object","properties":{"created_at":{"type":"number"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"incomplete_details":{"type":"null"},"instructions":{"type":"null"},"metadata":{"type":"null"},"model":{"type":"string"},"object":{"type":"string","const":"response"},"output":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ResponsesMessageOutput_Output"}},{"type":"null"}]},"output_text":{"type":"string"},"parallel_tool_calls":{"type":"boolean"},"temperature":{"type":"null"},"tool_choice":{"type":"string","const":"auto"},"tools":{"type":"array","items":{}},"top_p":{"type":"null"}},"required":["created_at","error","id","incomplete_details","instructions","metadata","model","object","output","output_text","parallel_tool_calls","temperature","tool_choice","tools","top_p"],"id":"ResponsesOutput_Output","additionalProperties":false},"PostResearchInput":{"type":"object","properties":{"excludeDomains":{"description":"The domains you want to exclude of the search. By default, don't restrict the search.","example":["wikipedia.org"],"type":"array","items":{"example":"wikipedia.org","type":"string"}},"fromDate":{"description":"The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before `toDate`, if provided, and later than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"includeDomains":{"description":"The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.","example":["microsoft.com","agolution.com"],"maxItems":100,"type":"array","items":{"example":"microsoft.com","type":"string"}},"includeImages":{"default":false,"description":"Defines whether the API should include images in its results.","anyOf":[{"type":"boolean"},{"type":"string"}]},"q":{"description":"The natural language question for which you want to retrieve context.","example":"What is Microsoft's 2024 revenue?","type":"string"},"structuredOutputSchema":{"default":null,"format":"json","description":"Required only when `outputType` is `structured`. Provide a JSON schema (as a string) representing the desired response format. The root must be of type `object`."},"toDate":{"description":"The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than `fromDate`, if provided, or than 1970-01-01.","example":"2025-01-01","anyOf":[{"type":"string"},{"type":"null"}]},"mode":{"default":"Auto","description":"Pin the research agent mode. Omit to let the agent auto-classify per request based on the question.","enum":["Answer","Auto","Investigate","Research"],"type":"string"},"outputType":{"type":"string","enum":["sourcedAnswer","structured"],"description":"The type of output you want to get. Use `structured` for a custom-formatted response defined by `structuredOutputSchema`."},"reasoningDepth":{"default":"L","description":"Pin the reasoning depth (S < M < L < XL). Defaults to L when omitted. Higher depths trade latency for thoroughness.","enum":["L","M","S","XL"],"type":"string"}},"required":["q","outputType"],"id":"PostResearchInput","example":{"excludeDomains":["wikipedia.org"],"includeDomains":["microsoft.com","agolution.com"],"includeImages":true,"outputType":"sourcedAnswer","q":"What is Microsoft's 2024 revenue?"}},"PostResearchOutput_Output":{"id":"PostResearchOutput_Output","$ref":"#/components/schemas/ResearchTaskOutput_Output"},"ListResearchOutput":{"type":"object","properties":{"metadata":{"type":"object","properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"total":{"type":"number"},"totalPages":{"type":"number"}},"required":["page","pageSize","total","totalPages"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ResearchTaskOutput"}}},"required":["metadata","data"],"id":"ListResearchOutput"}}}}