Skip to main content

A minimal CLI tool that turns natural language into instant APIs.

Project description

ask2api

CI PyPI version Python 3.9+ License: MIT

ask2api is a minimal Python CLI tool that turns natural language prompts into structured API-style JSON responses using LLM.

It allows you to define a JSON Schema and force the model to answer strictly in that format.

Why ask2api?

Because LLMs are no longer just chatbots, they are also programmable API engines.

ask2api lets you use them that way. 🚀

Key features:

  • Minimal dependencies
  • CLI first
  • Prompt → API behavior
  • No markdown, no explanations, only valid JSON
  • Vision modality support
  • Designed for automation pipelines and AI-driven backend workflows

Installation

pip install ask2api

Set your OpenAI key:

export OPENAI_API_KEY="your_api_key"

Usage

Text-only prompts

Instead of asking:

"Where is the capital of France?"

and receiving free-form text, you can do this:

ask2api -p "Where is the capital of France?" -sf schema.json

And get a structured API response:

{
  "country": "France",
  "city": "Paris"
}

Vision modality

You can also analyze images and get structured JSON responses:

ask2api -p "Where is this place?" -sf schema.json -i https://upload.wikimedia.org/wikipedia/commons/6/64/Lesdeuxmagots.jpg

How it works

  1. You define the desired output structure using a JSON Schema.
  2. The schema is passed to the model using OpenAI's json_schema structured output format.
  3. The system prompt enforces strict JSON-only responses.
  4. For vision tasks, images are automatically encoded (base64 for local files) or passed as URLs.
  5. The CLI prints the API-ready JSON output.

The model is treated as a deterministic API function.

Example schema

Create a file named schema.json:

{
  "type": "object",
  "properties": {
    "country": { "type": "string" },
    "city": { "type": "string" }
  },
  "required": ["country", "city"]
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ask2api-0.2.1.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ask2api-0.2.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file ask2api-0.2.1.tar.gz.

File metadata

  • Download URL: ask2api-0.2.1.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ask2api-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cc152f7ce5a19740b11174cec8a41c2c24b354df7e09b189f39aad18368d24e8
MD5 0a48f92f76c8dd9878c2004111d546a0
BLAKE2b-256 62b0f0674a07df69f03a9755637b8b52c9a5c99de53874de8790327d2b0b45d2

See more details on using hashes here.

File details

Details for the file ask2api-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: ask2api-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ask2api-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ecbac36d93c1ac5209374a304a44509d55fcc9212f38fd60351de001f1a358e2
MD5 66f81921980102018c5c01dbe1962ed6
BLAKE2b-256 b64a775fcf2804cecc149f146b6a3514a64cc4395aaf41274c99b1749fc89542

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page