Brian - Documentation
  • đŸ–ī¸Welcome
  • 👀Prompt-to-earn
  • 🤖Why an Intent Recognition Engine?
  • 🌐Brian AI models
  • 📜Prompt Guide
  • 🧠Use Cases
  • đŸ’ģPowered by Brian
  • â‰ī¸FAQ
  • Brian API
    • âš™ī¸APIs
      • đŸ’ģAPI Swagger
      • 💸/transaction
        • â›“ī¸Actions, Networks, and Tokens supported
          • Deposit and Withdraw to/from DeFi protocols
        • Transactions flow
          • EVM
          • Solana
          • Starknet
      • 📚/knowledge
        • 📑Knowledge Boxes
        • 🐝Public Embeddings
      • đŸ§™â€â™‚ī¸/agent
      • 🧑‍đŸ”Ŧ/parameters-extraction
      • 👨‍đŸ’ģ/smart-contract (alpha)
      • 📰/networks
      • â„šī¸/actions
    • đŸĨŗWhat's New?
    • 🔑API key
  • Brian SDK
    • 📚Brian Typescript SDK
  • AI AGENTS
    • 🤖LangChain<>Brian SDK
  • Brian App
    • 🍀Overview
    • 📤Send Transactions
    • 🙏Ask Brian
    • 🚚Deploy Smart Contracts
  • Misc.
    • Telegram Dev community
    • Website
    • Github
    • Medium
    • Twitter
    • HuggingFace
Powered by GitBook
On this page
  1. Brian API
  2. APIs

/parameters-extraction

Extract parameters from a prompt.

POST https://api.brianknows.org/api/v0/agent/parameters-extraction

Allows you to send a prompt to Brian and return all the extracted parameters from the prompt.

You can implement your own custom logic and decide how to use the extracted parameters in you app. For example, you could take the swap parameters and build an integration on a chain that is not currently supported by Brian.

Headers

Name
Type
Description

x-brian-api-key*

String

Brian API key.

Content-Type*

application/json

Body content type.

Request Body

Name
Type
Description

prompt*

String

User input prompt.

Requesting information

curl -XPOST "https://api.brianknows.org/api/v0/agent/parameters-extraction" -H "Content-Type: application/json" -H "x-brian-api-key: API_KEY" -d '{"prompt": "swap 1 eth to usdc on arbitrum"}'
Response
{
  "result": {
    "prompt": "swap 1 eth to usdc on arbitrum",
    "completion": [
      {
        "action": "swap",
        "token1": "eth",
        "chain": "usdc",
        "amount": "1".
        ... // other parameters
      }
    ]
  }
}
Previous/agentNext/smart-contract (alpha)

Last updated 5 months ago

âš™ī¸
🧑‍đŸ”Ŧ