Postman and OpenAPI
Downloads
Section titled “Downloads”| File | Use it for |
|---|---|
| Postman collection | Trying the endpoints by hand in Postman |
| OpenAPI description | Generating a client in another language, or loading into any OpenAPI tool |
| Python SDK | Calling the API from Python. See Python SDK |
| TypeScript SDK | Calling the API from TypeScript or JavaScript. See TypeScript SDK |
| Go SDK | Calling the API from Go. See Go SDK |
Both cover the public endpoints documented here.
Using the Postman collection
Section titled “Using the Postman collection”- In Postman, choose Import and select the downloaded file.
- Open the collection’s Variables tab and set
baseUrltohttps://api.ai4mproject.com. - Open its Authorization tab, choose Bearer Token, and paste your API key.
- Send periods first to confirm the key works.
Use a test key (ai4m_test_...) while exploring, so the requests do not count toward your monthly allowance.
Generating a client
Section titled “Generating a client”The OpenAPI description lists every endpoint and its parameters, so standard generators can produce the request code for you. It does not yet describe the response bodies in detail; use the field tables in the API reference for those.
For Python, TypeScript and Go, use the ready-made SDKs instead of generating one.