Reference

Create Chat Completions

Generate intelligent conversational responses and structured outputs in real-time using Parallel AI's chat interface, ideal for building interactive AI-powered features into your applications. Combine with advanced processing for research-grade results with citations and detailed reasoning.

List Monitor Events

Retrieve recent events and errors from your monitors in reverse chronological order, helping you quickly identify what's changed or broken. Perfect for tracking system health and troubleshooting issues without manual checking.

Retrieve Event Group

Fetch detailed information about a specific event group associated with a monitor to review execution history and performance data. This helps you understand what happened during monitored activities and diagnose issues.

Simulate Event

Test your monitor webhooks and event configurations by simulating real event triggers without waiting for actual events to occur. This helps ensure your monitoring setup works correctly before deploying to production.

Stream FindAll Events

Retrieves real-time updates on candidate discovery and matching progress as events stream from a FindAll run, allowing you to monitor recruitment activities as they happen without waiting for completion.

Stream Task Group Events

Get real-time updates about task group progress and completion status as events happen, allowing you to monitor multiple tasks without constant manual checks.

Stream Task Run Events

Monitor real-time progress updates and status changes for your automated tasks as they execute, helping you track workflow completion and identify any issues immediately.

Extract Content from URLs

Fetch and extract relevant content from web URLs, optionally focusing on specific information or topics you care about. Perfect for gathering information from multiple sources quickly without manually visiting each site.

Create Monitor

Set up automatic monitoring of web search results for specific queries, with periodic checks on your chosen schedule to track how information changes over time. This helps you stay informed about topics relevant to your business without manual checking.

List Monitors

Retrieve all active monitors configured in your account along with their current status and settings to track what's being monitored across your systems.

Delete Monitor

Permanently removes a monitor and stops all its future executions, preventing any further automated checks or notifications from running.

Retrieve Monitor

Fetch the complete configuration and current status of a specific monitor, including its checking frequency, monitoring rules, and notification settings. This lets you verify how your monitors are set up and ensure they're working as intended.

Update Monitor

Modify an existing monitor's settings including its monitoring frequency, query parameters, metadata, or webhook notifications. Use this when you need to adjust how and when a monitor checks your system.

Start FindAll Run

Discover and match entities across your data using natural language descriptions, with support for custom filters and automated notifications when results are ready.

Add Enrichment to FindAll Run

Enhance your search results by adding structured data fields to extract additional information from matched entities using a JSON schema definition.

Cancel FindAll Run

Stop an active FindAll operation that's currently running, allowing you to halt data retrieval before it completes. Use this when you need to cancel a search or find operation that's taking too long or is no longer needed.

Extend FindAll Run

Increases the number of results returned from a completed or active search operation without having to restart it from scratch. This saves time when you need more matches than your original search limit allowed.

Get FindAll Run Result

Retrieves the final list of matched and unmatched candidates from a completed or in-progress search operation, allowing you to see who was found and who wasn't.

Get FindAll Run Schema

Retrieve the complete schema and configuration details for a FindAll run, including its search objectives, entity types, and matching criteria. Use this to understand how a previous search was set up before replicating or modifying it.

Ingest FindAll Run

Converts natural language search queries into structured specifications for finding and retrieving data, enabling you to automate how you search and filter information across your systems.

Parallel Search

Search across multiple topics or questions at once to quickly find the most relevant documents or information. This saves time when you need answers to several related questions without making separate searches.

Retrieve FindAll Run Status

Check the progress and completion status of a data retrieval operation to see how many records have been processed and when it will finish.

Add Runs to Task Group

Executes multiple tasks simultaneously within a task group, allowing you to run several operations in parallel rather than sequentially. This saves time when you need multiple related tasks completed at once.

Create Task Group

Create a task group to organize and track multiple tasks that run in parallel, making it easier to manage related work as a single unit.

Fetch Task Group Runs

Retrieve all task runs from a task group with the ability to resume fetching where you left off, optionally including the inputs and outputs for each run. This helps you monitor and analyze batch processing results without losing your place if the connection interrupts.

Retrieve Task Group

Fetch detailed information about a specific task group by ID, including its status, members, and associated tasks to track project progress and team coordination.

Retrieve Task Group Run

Check the current status and progress of a task group run using its unique identifier, helping you monitor whether parallel tasks have completed or are still in progress.

Create Task Run

Initiates an asynchronous task execution that processes in the background, allowing you to queue work without waiting for immediate completion. Ideal for handling time-consuming operations while keeping your workflow responsive.

Retrieve Task Run Result

Waits for a task to finish executing and retrieves its final result, blocking until completion or timeout. Essential for workflows where you need to ensure a task completes before proceeding with dependent actions.

Retrieve Task Run

Check the current status and details of a specific task execution to monitor progress and track completion. This helps you verify whether automated workflows or background jobs have finished processing and see their outcomes.

Retrieve Task Run Input

Access the original input data and parameters that were submitted for a specific task run, allowing you to review what was sent and troubleshoot task execution issues.

Suggest Task

Converts your task ideas into structured, actionable task specifications by analyzing your natural language description of what you want to accomplish.