Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docsa.stemfard.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through making your first request to the Stemfard API. By the end, you’ll have sent a matrix addition request, read the structured response, and learned how to adjust the api_level parameter to get exactly the amount of detail your application needs.
1

Get your API key

Sign in to the Stemfard dashboard and navigate to API Keys. Copy your key — you’ll pass it as a Bearer token in the Authorization header of every request.Keep your API key secure. Do not commit it to source control or expose it in client-side code.
2

Install a REST client or use curl

You can call the Stemfard API from any HTTP client. The examples below use curl, the JavaScript Fetch API, and the Python requests library. No additional SDK installation is required.
3

Make your first request

Send a POST request to the matrix addition endpoint. Replace YOUR_API_KEY with the key you copied from the dashboard.
curl --request POST \
  --url https://api.stemfard.com/api/v1/mathematics/linear-algebra/matrix-operations/matrix-arithmetic/add \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "a": [[5, 1, 6], [3, 4, 5], [6, 4, 8]],
    "b": [[-4, -2, 6], [4, 7, -3], [7, -3, 5]],
    "api_level": "standard",
    "result_name": "M"
  }'
4

Understand the response

A successful standard request returns a JSON object with the computed result and a solution step. Here is what the response looks like for the request above:
{
  "metadata": {
    "result_name": "M",
    "operation": "add"
  },
  "taxonomy": {
    "topic": "Matrix Arithmetic",
    "subtopic": "Matrix Addition"
  },
  "result": {
    "M": [[1, -1, 12], [7, 11, 2], [13, 1, 13]]
  },
  "steps": [
    {
      "step": 1,
      "description": "Add corresponding elements of matrices A and B",
      "html": "<p>M = A + B</p>",
      "latex": "M = A + B"
    }
  ]
}
Key fields in the response:
  • metadata.result_name — The label assigned to the output matrix, set by your result_name parameter.
  • metadata.operation — The operation performed, useful for logging and display.
  • taxonomy — Classifies the computation by topic and subtopic for educational categorization.
  • result — Contains the computed matrix under the key you specified in result_name.
  • steps — An array of solution steps. Each step includes a plain-text description, an html representation, and a latex expression for rendering in educational interfaces.
5

Customize the response

The api_level parameter controls how much information the API returns. Use it to match the response to your application’s needs:
  • lite — Returns only the computed result. Best for applications that just need the answer.
  • standard — Returns the result along with solution steps. Suitable for most educational use cases.
  • detailed — Returns the full educational response, including extended explanations, multiple output formats, and related learning pathways.
To get just the answer without solution steps, set api_level to "lite":
{
  "a": [[5, 1, 6], [3, 4, 5], [6, 4, 8]],
  "b": [[-4, -2, 6], [4, 7, -3], [7, -3, 5]],
  "api_level": "lite",
  "result_name": "M"
}
To unlock full educational content including speech-ready explanations and learning pathways, use "detailed":
{
  "a": [[5, 1, 6], [3, 4, 5], [6, 4, 8]],
  "b": [[-4, -2, 6], [4, 7, -3], [7, -3, 5]],
  "api_level": "detailed",
  "result_name": "M"
}
For a full breakdown of what each API level returns, see API levels.

Next steps

API reference

Browse all available endpoints with full request parameters, response schemas, and live examples.

API levels

Understand the difference between lite, standard, and detailed responses and when to use each.