# API Overview

| Overview       |                                                                                              |
| -------------- | -------------------------------------------------------------------------------------------- |
| API Endpoint   | <https://app.eduflow.com/api/graphql>                                                        |
| Authentication | Authorization headers and session based for GraphiQL explorer                                |
| Scope          | Institution-wide: Institution data, courses, participants, activities, reviews, summary data |

{% hint style="info" %}
We're actively working on expanding our API to cover more use cases and be friendlier to use. To stay up to date, see our [changelog](/api-changelog.md).
{% endhint %}

## Learn GraphQL

[GraphQL](https://graphql.org/) is an API standard used across many websites (Facebook, GitHub). It's a big step from querying with REST. Take a dive into our GraphQL primer below.

{% content-ref url="/pages/-MSZMhX10JOvX-sqBCjG" %}
[Introduction to GraphQL](/graphql/graphql.md)
{% endcontent-ref %}

## Authenticate

Create an access key and learn how to authorize with the API.

{% content-ref url="/pages/-MSFG0eGQ527ETMz-zBC" %}
[Authentication](/getting-started-1/authentication.md)
{% endcontent-ref %}

## Usage

Try your first query with the Eduflow API.

{% content-ref url="/pages/-MSZSdRNuJ55VV0fsX9c" %}
[Usage](/getting-started-1/usage.md)
{% endcontent-ref %}

## Learn Eduflow's structure

Check out the object graph for an overview of how data is laid out in Eduflow.

* [Institution](/guides/institutions.md)
  * [Course](/guides/courses.md)
    * [Participants](/guides/courses.md#course-participants)
    * [Flows](/guides/flows-and-activities.md#flows)
      * [Activities ](/guides/flows-and-activities.md#activities)- submission, reviews, etc
        * [Scores ](/guides/course-summary-outputs.md)- feedback, submission, combined scores
        * [Submissions ](/guides/course-summary-outputs.md#submission)- pdf, xls, google drive, links, rich text

## Keeping up to date and sharing your ideas

Check out Eduflow's [Canny changelog](https://eduflow.canny.io/changelog) to see our latest activities. For upcoming changes, see our [Roadmap](https://eduflow.canny.io/) where you can vote on features and suggest features and enhancements to Eduflow and the Public API.

{% content-ref url="/pages/-MRzzLl\_lPTXiNcy59xF" %}
[Broken mention](broken://pages/-MRzzLl_lPTXiNcy59xF)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eduflow.com/getting-started-1/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.