Skip to main content
Server path: /embedded-openai-deep-research | Type: Embedded | PCID required: No

Tools

ToolDescription
embedded-openai-deep-research_researchStart an async deep research task using OpenAI deep research models (10–30 minutes). Saves the result to a file storage collection — defaults to “Multimedia Artifact” unless collectionId is set. Returns a responseId and signedUrl to track progress.
embedded-openai-deep-research_check_statusCheck the status of a previously started deep research task. Poll this until status is “completed” or “failed”. When completed, the final results are also saved to the file storage collection from the original request.

embedded-openai-deep-research_research

Start an async deep research task using OpenAI deep research models (10–30 minutes). Saves the result to a file storage collection — defaults to “Multimedia Artifact” unless collectionId is set. Returns a responseId and signedUrl to track progress. Parameters:
ParameterTypeRequiredDefaultDescription
modelstringNo"o4-mini-deep-research"
Select the appropriate deep research model:
- o4-mini-deep-research: Fast, cost-effective deep research (default)
- o3-deep-research: Advanced reasoning, deep research tasks
userPromptstringYesThe research question or task to investigate
fileUrlsstring[]NoOptional array of file URLs to include as research context
outputFileNamestringNoOptional output filename. Defaults to “openai-deep-research-result-<responseId>.txt”.
reasoningEffortstringNo"low"Reasoning effort level — lower effort is faster but less thorough
collectionIdstringNoOptional file storage collection ID to store the output. Defaults to the Multimedia Artifact collection.
triggerUrlsobjectNoCalled when research completes. Example: { “https://triggers.app.pinkfish.ai/ext/triggers/EXAMPLE_TRIGGER_ID”: “EXAMPLE_API_KEY” }

embedded-openai-deep-research_check_status

Check the status of a previously started deep research task. Poll this until status is “completed” or “failed”. When completed, the final results are also saved to the file storage collection from the original request. Parameters:
ParameterTypeRequiredDefaultDescription
responseIdstringYesThe responseId returned from embedded-openai-deep-research_research