mirror of
https://github.com/OpenBMB/ChatDev.git
synced 2026-04-25 11:18:06 +00:00
1.7 KiB
1.7 KiB
name, description, allowed-tools
| name | description | allowed-tools |
|---|---|---|
| rest-api-caller | Call REST APIs from Python, parse JSON responses, and report the useful fields back to the user. | execute_code |
REST API Caller
Use this skill when the user wants data fetched from an HTTP API, especially a REST endpoint that returns JSON.
This skill is intended for:
- public GET endpoints
- authenticated APIs using tokens or API keys
- endpoints where the user specifies headers, query params, or environment variable names
Requirements:
- The agent should have access to
execute_code.
Workflow:
- Activate this skill when the task requires calling an API.
- If you need examples, call
read_skill_fileforreferences/examples.md. - Write a short Python script that performs the request.
- Prefer the
requestslibrary if available in the environment. - Prefer
execute_code. - Parse the response and print only the fields needed for the final answer.
- Summarize the API result clearly for the user.
Rules:
- Do not invent API responses. Run the request first.
- For JSON APIs, parse JSON and extract the relevant fields instead of dumping the whole payload unless the user asks for the raw body.
- If the user provides an environment variable name for a token or API key, read it from
os.environinside the script. - If the endpoint requires auth and no credential source is provided, say what is missing.
- If the request fails, report the HTTP status code or error message clearly.
- Do not claim there is a generic execution-environment issue unless the tool call actually returned one.
Demo endpoint:
GET https://official-joke-api.appspot.com/random_joke
Expected behavior for the demo endpoint:
- Fetch one random joke
- Return the setup and punchline in a readable format