The new way to API.

Verb References

Table Of Contents

This document provides a comprehensive reference for AgenticAPI verbs, including current, proposed, and industry-inspired verbs. Each verb is categorized, defined, and illustrated with use cases and examples, enabling developers to understand and implement action-oriented APIs. The verbs align with the ACTION framework, supporting tasks from data retrieval to workflow orchestration.

Current Verbs #

SUMMARIZE #

  • Category: Compute
  • Definition: Create a concise version of a source input.
  • Use Case: Summarize a meeting transcript into action items.
  • Example: SUMMARIZE /meeting-notes

FETCH #

  • Category: Acquire
  • Definition: Retrieve a specific, known data asset.
  • Use Case: Fetch a document by ID for processing.
  • Example: FETCH /document

NOTIFY #

  • Category: Communicate
  • Definition: Deliver a status or event message to a specified recipient.
  • Use Case: Notify a user of a password change.
  • Example: NOTIFY /user

Proposed Verbs #

EXTRACT #

  • Category: Acquire
  • Definition: Pull specific content or fields from an unstructured or complex source.
  • Use Case: Extract named entities from a legal document.
  • Example: EXTRACT /document

FILTER #

  • Category: Compute
  • Definition: Exclude or include data based on specified rules.
  • Use Case: Filter transactions above $5000 for review.
  • Example: FILTER /transactions

CHECK #

  • Category: Acquire/Compute
  • Definition: Verify the status or state of a resource or condition.
  • Use Case: Check product availability or weather conditions.
  • Example: CHECK /weather, CHECK /status

GENERATE #

  • Category: Compute
  • Definition: Produce textual or structured documentation from a data source.
  • Use Case: Generate technical documentation from an OpenAPI spec.
  • Example: GENERATE /documentation?source=api-spec

IMPORT #

  • Category: Integrate
  • Definition: Bring external data into a controlled environment.
  • Use Case: Import user contact data from a CSV file.
  • Example: IMPORT /contacts

LINK #

  • Category: Integrate
  • Definition: Associate or relate two entities or systems.
  • Use Case: Link a user account to a third-party authentication provider.
  • Example: LINK /auth-provider

LOG #

  • Category: Communicate
  • Definition: Persist information for future reference or auditability.
  • Use Case: Log user authentication attempts.
  • Example: LOG /auth-events

MAP #

  • Category: Integrate
  • Definition: Define relationships between fields, types, or structures.
  • Use Case: Map internal job titles to standardized role definitions.
  • Example: MAP /roles

MERGE #

  • Category: Integrate
  • Definition: Combine data or records into a unified entity.
  • Use Case: Merge duplicate customer profiles.
  • Example: MERGE /profile

MONITOR #

  • Category: Acquire
  • Definition: Observe a system or data stream over time for changes.
  • Use Case: Monitor product prices for a drop below $100.
  • Example: MONITOR /products

NORMALIZE #

  • Category: Orchestrate
  • Definition: Standardize data from multiple sources to a common format.
  • Use Case: Normalize customer data from regional CRMs.
  • Example: NORMALIZE /customer-data

PAUSE #

  • Category: Orchestrate
  • Definition: Temporarily halt task execution.
  • Use Case: Pause an active ad campaign.
  • Example: PAUSE /campaign

PREDICT #

  • Category: Compute
  • Definition: Forecast a value or outcome based on a model.
  • Use Case: Predict customer churn likelihood.
  • Example: PREDICT /churn

PUBLISH #

  • Category: Communicate
  • Definition: Make content accessible to a broader audience.
  • Use Case: Publish a press release to the newsroom.
  • Example: PUBLISH /news

PURCHASE #

  • Category: Transact
  • Definition: Execute a financial transaction for goods or services.
  • Use Case: Purchase a subscription plan.
  • Example: PURCHASE /subscription

RANK #

  • Category: Compute
  • Definition: Order a list of items by score or relevance.
  • Use Case: Rank products by purchase likelihood.
  • Example: RANK /products

REGISTER #

  • Category: Transact
  • Definition: Enroll a user or entity into a system or process.
  • Use Case: Register a participant for a webinar.
  • Example: REGISTER /event

REPLY #

  • Category: Communicate
  • Definition: Provide a direct response to an incoming message.
  • Use Case: Reply to a support inquiry with details.
  • Example: REPLY /inquiry

REPORT #

  • Category: Communicate
  • Definition: Generate and send structured summaries or metrics.
  • Use Case: Report weekly analytics to a dashboard.
  • Example: REPORT /analytics

RESUME #

  • Category: Orchestrate
  • Definition: Restart a paused or deferred task.
  • Use Case: Resume system updates after downtime.
  • Example: RESUME /updates

RETRY #

  • Category: Orchestrate
  • Definition: Reattempt a failed or incomplete task.
  • Use Case: Retry a failed payment for an order.
  • Example: RETRY /payment

ROUTE #

  • Category: Orchestrate
  • Definition: Direct requests or events to the appropriate service.
  • Use Case: Route support tickets to regional helpdesks.
  • Example: ROUTE /ticket

SCAN #

  • Category: Acquire
  • Definition: Sweep a dataset for predefined signals or anomalies.
  • Use Case: Detect security breaches in system logs.
  • Example: SCAN /logs

SEARCH #

  • Category: Acquire
  • Definition: Locate data based on query criteria.
  • Use Case: Find documents mentioning “hydrogen fuel cells.”
  • Example: SEARCH /documents

SCHEDULE #

  • Category: Orchestrate
  • Definition: Define a time-based plan for task execution.
  • Use Case: Schedule a weekly data pipeline run.
  • Example: SCHEDULE /pipeline

SIGN #

  • Category: Transact
  • Definition: Provide legal or digital confirmation of an agreement.
  • Use Case: Sign a contract digitally.
  • Example: SIGN /agreement

SUBMIT #

  • Category: Transact
  • Definition: Send a document or form for review or processing.
  • Use Case: Submit a reimbursement claim.
  • Example: SUBMIT /claim

SYNC #

  • Category: Integrate
  • Definition: Reconcile and align the state of multiple systems.
  • Use Case: Sync product inventory between stores.
  • Example: SYNC /inventory

TRANSFER #

  • Category: Transact
  • Definition: Move assets or ownership between parties.
  • Use Case: Transfer loyalty points to another account.
  • Example: TRANSFER /points

TRANSFORM #

  • Category: Orchestrate
  • Definition: Convert data from one format or schema to another.
  • Use Case: Transform a vendor’s JSON payload to internal format.
  • Example: TRANSFORM /payload

TRANSLATE #

  • Category: Compute
  • Definition: Convert text or data to another language or structure.
  • Use Case: Translate product descriptions into French.
  • Example: TRANSLATE /description

VALIDATE #

  • Category: Compute
  • Definition: Check data conformity to expected formats or rules.
  • Use Case: Validate an invoice before submission.
  • Example: VALIDATE /invoice

Industry-Inspired Verbs #

SET #

  • Category: Transact
  • Definition: Configure settings or parameters.
  • Use Case: Set an alarm or adjust temperature.
  • Example: SET /alarm, SET /temperature

TAKE #

  • Category: Transact
  • Definition: Perform specific actions or acquire items.
  • Use Case: Take a picture or notes.
  • Example: TAKE /picture, TAKE /notes

RUN #

  • Category: Compute/Orchestrate
  • Definition: Execute processes or tasks.
  • Use Case: Run a report or diagnostics.
  • Example: RUN /report, RUN /diagnostics

OPEN #

  • Category: Transact
  • Definition: Access or initiate resources or discussions.
  • Use Case: Open an app or discussion.
  • Example: OPEN /app, OPEN /discussion

START #

  • Category: Orchestrate
  • Definition: Begin tasks or processes.
  • Use Case: Start a timer or project.
  • Example: START /timer, START /project

FIND #

  • Category: Acquire
  • Definition: Locate items or information.
  • Use Case: Find a file or restaurant.
  • Example: FIND /file, FIND /restaurant

SHOW #

  • Category: Communicate
  • Definition: Display information or results.
  • Use Case: Show results or location.
  • Example: SHOW /results, SHOW /location

CALL #

  • Category: Communicate
  • Definition: Initiate communication or processes.
  • Use Case: Call someone or a meeting.
  • Example: CALL /contact, CALL /meeting

PULL #

  • Category: Acquire
  • Definition: Extract data or resources.
  • Use Case: Pull data or a file.
  • Example: PULL /data, PULL /file

MAKE #

  • Category: Transact
  • Definition: Create or decide on actions.
  • Use Case: Make a call or decision.
  • Example: MAKE /call, MAKE /decision

SEND #

  • Category: Communicate
  • Definition: Transmit information or resources.
  • Use Case: Send an email or feedback.
  • Example: SEND /email, SEND /feedback

TURN #

  • Category: Transact
  • Definition: Adjust states or submit items.
  • Use Case: Turn on lights or submit an assignment.
  • Example: TURN /lights, TURN /assignment

BREAK #

  • Category: Compute
  • Definition: Interrupt or analyze processes.
  • Use Case: Break down data or the ice.
  • Example: BREAK /data, BREAK /ice

Notes #

  • Current Verbs: SUMMARIZE, FETCH, NOTIFY are implemented in AgenticAPI v0.3.0.
  • Proposed Verbs: Planned for v0.4.0 or later, expanding functionality.
  • Industry Verbs: Inspired by common tasks, adaptable to AgenticAPI’s framework.
  • Categories: Align with ACTION framework (Acquire, Compute, Transact, Communicate, Orchestrate, Integrate).

Next Steps #

What are your feelings
Updated on May 29, 2025