Neynar · Example Payload

Lookup Cast Conversation Summary

Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.

Agents

Lookup Cast Conversation Summary is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

{
  "operationId": "lookup-cast-conversation-summary",
  "method": "GET",
  "path": "/v2/farcaster/cast/conversation/summary/",
  "summary": "Cast conversation summary",
  "description": "Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL.  Summary is generated by an LLM and is intended to be passed as a context to AI agents.",
  "tags": [
    "Agents"
  ],
  "parameters": [
    {
      "name": "identifier",
      "in": "query",
      "required": true,
      "description": "Cast identifier (It's either a URL or a hash))",
      "schema": {
        "example": "0x9288c1e862aa72bd69d0e383a28b9a76b63cbdb4",
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of casts to consider in a summary up to a point of target cast",
      "schema": {
        "default": 20,
        "example": 50,
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "prompt",
      "in": "query",
      "required": false,
      "description": "Additional prompt used to generate a summary",
      "schema": {
        "example": "be unreasonably dramatic",
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/ConversationSummary"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}