EdGate Data Service API

https://edgate.com/api/docs
Admin
The EdGate Data Service API is a REST-based platform providing secure access to EdGate's data...
Tokens:19,934
Snippets:69
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### POST /concepts/suggest/{GUID}

Source: https://edgate.com/api/docs/concepts

Suggest concepts for a specific content item based on its metadata. This endpoint leverages the item's GUID to find relevant conceptual tags.

```APIDOC
## GET /concepts/suggest/{GUID}

### Description
Suggest concepts for a specific content item, based on its metadata.

### Method
GET

### Endpoint
/concepts/suggest/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of content item

#### Query Parameters
- **fields** (string) - Optional - Comma separated list of data fields to use as basis of suggestion. Default is "title". "description" and any other field defined in the /content/filters endpoint are accepted.
- **useconcepts** (boolean) - Optional - Use existing concepts already tagged to item as basis for suggestion. Ignores any values passed in the fields parameter if set to "true"
- **limit** (integer) - Optional - The number of concepts to return (default is 10)
- **scope** (integer) - Optional - Scope of precision to use in making suggestion. Scale from 1-10 (default is 5). 1 is the most precise, using the most relevant source data, but yielding less results. The higher the value, the larger the number of possible suggestions, but at the cost of being less relevant.

### Response
#### Success Response (200)
- The response is a list of concept objects (See Table 12).

#### Response Example
```json
{
  "concepts": [
    {
      "id": "concept_guid_1",
      "name": "Example Concept 1"
    },
    {
      "id": "concept_guid_2",
      "name": "Example Concept 2"
    }
  ]
}
```
```

--------------------------------

### Get Content by Concept GUID (GET /concepts/content/{GUID})

Source: https://edgate.com/api/docs/concepts

Retrieves content items tagged with a specific concept GUID. Supports filtering, 'limit', and 'offset' parameters. Returns a Content Result object.

```HTTP
GET /concepts/content/a1b2c3d4-e5f6-7890-1234-567890abcdef?filters=contentType|video,provider|edgate&limit=5
```

--------------------------------

### Get Standards by Concept GUID (GET /concepts/standards/{GUID})

Source: https://edgate.com/api/docs/concepts

Retrieves standards tagged with a specific concept GUID. Supports filtering by 'set' and 'grade'. Returns a list of Standards Group objects.

```HTTP
GET /concepts/standards/a1b2c3d4-e5f6-7890-1234-567890abcdef?set=core&grade=3
```

--------------------------------

### Suggest Concepts by Item Metadata (GET)

Source: https://edgate.com/api/docs/concepts

Suggests concepts based on the metadata of a given content item. Accepts parameters for the content item GUID, fields to use for suggestions, whether to use existing concepts, the number of results, and the precision scope.

```HTTP
GET /concepts/suggest/{GUID}?fields=title,description&useconcepts=true&limit=5&scope=3
```

--------------------------------

### View Metadata for a Single Content Item by GUID (GET /content/{GUID})

Source: https://edgate.com/api/docs/content

Retrieves all metadata for a specific content item using its globally unique identifier (GUID). Returns a single Content object.

```HTTP
GET /content/{GUID}
```

--------------------------------

### Get Concept by GUID (GET /concepts/{GUID})

Source: https://edgate.com/api/docs/concepts

Retrieves a specific concept by its unique GUID. Returns a Concept JSON object.

```HTTP
GET /concepts/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

--------------------------------

### Suggest Concepts by Term (GET)

Source: https://edgate.com/api/docs/concepts

Suggests concepts based on a provided search string. Allows specifying the number of results and the precision scope for the suggestions.

```HTTP
GET /concepts/suggest/?q=example%20search%20term&limit=10&scope=5
```

--------------------------------

### GET /content/related/{GUID} - Get related content

Source: https://edgate.com/api/docs/content

Allows a client to look up content covering similar concept areas for a specific content item.

```APIDOC
## GET /content/related/{GUID}

### Description
Allows a client to look up content covering similar concept areas for a specific content item.

### Method
GET

### Endpoint
/content/related/{GUID}

### Parameters
#### Path Parameters
- **guid** (string) - Required - GUID of the content item.

#### Query Parameters
- **filters** (string) - Optional - Comma-separated list of name/value pairs. Field name and value are delimited with a pipe character “|”. Available filter fields and values can be found via the /content/filters endpoint.
- **limit** (integer) - Optional - The number of results to return (default is 25).
- **offset** (integer) - Optional - Numbering of record to begin the results at (used for paging).

### Response
#### Success Response (200)
Returns a Search Result JSON object (see Table 5).

**Table 5 - Search Result object**
- **count** (integer) - The total number of results available.
- **results** (List) - A list of content items matching the query.
  - Each item in the list is a content object with fields like `guid`, `title`, `description`, `url`, etc.

#### Response Example
```json
{
  "count": 10,
  "results": [
    {
      "guid": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
      "title": "Related Content Example",
      "description": "Another piece of related content.",
      "url": "http://example.com/related/1"
    }
  ]
}
```
```

--------------------------------

### POST /concepts/suggest/

Source: https://edgate.com/api/docs/concepts

Suggest concepts based on a provided string. This endpoint is useful for finding concepts when a specific content item GUID is not available.

```APIDOC
## GET /concepts/suggest/

### Description
Suggest concepts based on a string.

### Method
GET

### Endpoint
/concepts/suggest/

### Parameters
#### Query Parameters
- **q** (string) - Required - String to use as basis for suggestion
- **limit** (integer) - Optional - The number of concepts to return (default is 10)
- **scope** (integer) - Optional - Scope of precision to use in making suggestion. Scale from 1-10 (default is 5). 1 is the most precise, using the most relevant source data, but yielding less results. The higher the value, the larger the number of possible suggestions, but at the cost of being less relevant.

### Response
#### Success Response (200)
- The response is a list of Concept objects (See Table 12).

#### Response Example
```json
{
  "concepts": [
    {
      "id": "concept_guid_1",
      "name": "Example Concept 1"
    },
    {
      "id": "concept_guid_2",
      "name": "Example Concept 2"
    }
  ]
}
```
```

--------------------------------

### Get Child Concepts by GUID (GET /concepts/browse/{GUID})

Source: https://edgate.com/api/docs/concepts

Retrieves all child concepts for a given concept GUID. Returns a list of Concept JSON objects.

```HTTP
GET /concepts/browse/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

--------------------------------

### GET /profile/

Source: https://edgate.com/api/docs/profile

Retrieves a listing of all available data sets and parameters accessible within the client's profile. These can be used in subsequent API requests.

```APIDOC
## GET /profile/

### Description
Retrieves a listing of all available data sets and parameters accessible within the client's profile. These can be used in subsequent API requests.

### Method
GET

### Endpoint
/profile/

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **standards_sets** (list) - A list of standards sets the profile has access to
  - **set_id** (string) - An identifier for the standards set
  - **name** (string) - Name of the standards set
  - **parent** (string, optional) - Name of the parent group the standards set belongs to
- **content_sets** (list, optional) - A list of content sets the profile has access to
  - **set_id** (integer) - An identifier for the content set
  - **name** (string) - Name of the content set
- **subjects** (list) - A list of subject areas the profile has access to
- **grades** (list) - A list of grades the profile has access to
- **textbooks** (list, optional) - A list of textbooks the profile has access to
  - **textbook_id** (string) - An identifier for the textbook
  - **name** (string) - Title of the textbook
  - **thumbnail** (string, optional) - URL of a thumbnail of the textbook’s cover

#### Response Example
{
  "standards_sets": [
    {
      "set_id": "Common Core",
      "name": "Common Core State Standards",
      "parent": "US"
    }
  ],
  "content_sets": [
    {
      "set_id": 101,
      "name": "Example Content Set"
    }
  ],
  "subjects": ["Math", "Science"],
  "grades": ["K", "1", "2"],
  "textbooks": [
    {
      "textbook_id": "MATH101",
      "name": "Introduction to Algebra",
      "thumbnail": "http://example.com/thumbnails/math101.jpg"
    }
  ]
}
```

--------------------------------

### Get Concept by GUID

Source: https://edgate.com/api/docs/concepts

Retrieves a specific concept from the index using its unique GUID.

```APIDOC
## GET /concepts/{GUID}

### Description
Gets a concept by its GUID.

### Method
GET

### Endpoint
/concepts/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the concept

### Response
#### Success Response (200)
- Returns a Concept object (see Table 12 in documentation).

### Response Example
```json
{
  "guid": "example-guid-1",
  "name": "Example Concept 1",
  "parent": {
    "guid": "parent-guid-1",
    "name": "Parent Concept 1"
  },
  "children": ["child-guid-1", "child-guid-2"]
}
```
```

--------------------------------

### Get a listing of available standards

Source: https://edgate.com/api/docs/standards

Retrieves a list of all available standards sets within the client profile. This data is identical to what is found in the profile endpoint.

```APIDOC
## Get a listing of available standards

### Description
This endpoint returns a listing of standards sets available in the client profile, identical to the data in the profile endpoint.

### Method
GET

### Endpoint
/standards/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **standards_sets** (list) - A list of standards sets the profile has access to.
  - **standards_sets.set_id** (string) - An identifier for the standards set.
  - **standards_sets.name** (string) - Name of the standards set.
  - **standards_sets.parent** (string, optional) - Name of the parent group the standards set belongs to.

#### Response Example
{
  "standards_sets": [
    {
      "set_id": "common_core",
      "name": "Common Core State Standards",
      "parent": "US"
    },
    {
      "set_id": "ngss",
      "name": "Next Generation Science Standards"
    }
  ]
}
```

--------------------------------

### Get data for an individual standard

Source: https://edgate.com/api/docs/standards

Retrieves detailed metadata for a single standard using its unique GUID.

```APIDOC
## Get data for an individual standard

### Description
This endpoint returns metadata about a single standard identified by its GUID.

### Method
GET

### Endpoint
/standards/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the standard to retrieve.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **guid** (string) - GUID of the standard.
- **set** (string) - ID of the standards set the standard belongs to.
- **standard_number** (string) - The numbering designation provided by the standards issuing authority.
- **standard_text** (string) - The text of the standard.
- **label** (string) - The leveling nomenclature for the standard.
- **depth** (integer) - The level depth of the standard.
- **subject** (list) - The general subject areas of the standard.
- **grade** (list) - The grade levels of the standard.
- **adopted** (string) - The year (and possibly month) the standard was adopted.
- **modified** (timestamp) - Timestamp of when the standard record was last modified in the EdGate repository (YYYY-MM-DD hh:mm:ss-TZ).
- **parent** (string) - GUID of parent standard.
- **children** (list) - List of GUIDs of child standards.
- **metadata** (list) - Additional data about the standard.
  - **metadata.name** (string) - Name of data field.
  - **metadata.value** (string) - Value of data field.
- **correlated** (boolean, optional) - Status if the standard has correlated materials in the client's profile (only appears if "correlate" parameter is true).

#### Response Example
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "set": "common_core",
  "standard_number": "CCSS.ELA-Literacy.RL.4.1",
  "standard_text": "Refer to details and examples in text.",
  "label": "Grade 4 Reading Literature",
  "depth": 3,
  "subject": ["English Language Arts"],
  "grade": ["4"],
  "adopted": "2010-06",
  "modified": "2023-10-27 10:00:00-05:00",
  "parent": "a1b2c3d4-e5f6-7890-1234-567890abcde0",
  "children": [],
  "metadata": [
    {
      "name": "Common Core Domain",
      "value": "Reading: Literature"
    }
  ],
  "correlated": true
}
```

--------------------------------

### Get Related Concepts by GUID (GET)

Source: https://edgate.com/api/docs/concepts

Retrieves concepts that are related to a specific concept, identified by its GUID. This endpoint is used to explore conceptual relationships within the Edgate system.

```HTTP
GET /concepts/related/{GUID}
```

--------------------------------

### Get Profile Information (GET /profile/)

Source: https://edgate.com/api/docs/profile

Retrieves a listing of all available data sets and parameters for the client's profile. This information is crucial for constructing valid API requests. The response is a JSON object detailing various profile attributes.

```HTTP
GET /profile/
```

--------------------------------

### Get Correlated Standards for Content Item (GET Request)

Source: https://edgate.com/api/docs/correlation

This GET request retrieves a list of standards that correlate to a specific content item. Results can be filtered by standards set, grade, and subject area. The 'guid' parameter is required in the path, while 'set', 'subject', and 'grade' are optional query string parameters.

```http
GET /correlations/content/{GUID}?set={set_id}&subject={subject_area}&grade={grade_level} HTTP/1.1
Host: api.example.com
```

--------------------------------

### Get Content Tagged with Concept

Source: https://edgate.com/api/docs/concepts

Retrieves content items tagged with a specific concept. Supports filtering, limiting, and pagination.

```APIDOC
## GET /concepts/content/{GUID}

### Description
Retrieves content items tagged with a specific concept.

### Method
GET

### Endpoint
/concepts/content/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the concept
#### Query Parameters
- **filters** (string) - Optional - Comma separated list of name/value pairs. Field name and value are delimited with a pipe character “|”. Available filter fields and values can be found via the /content/filters endpoint.
- **limit** (integer) - Optional - The number of results to return (default is 25)
- **offset** (integer) - Optional - Numbering of record to begin the results at (used for paging)

### Response
#### Success Response (200)
- This endpoint returns a Content Result object (See Table 5 in documentation).

### Response Example
```json
{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "resultcount": 50,
  "offset": 0,
  "limit": 10,
  "results": [
    {
      "content_id": "content-abc",
      "title": "Example Content Item"
    }
  ]
}
```
```

--------------------------------

### View Metadata for a Single Content Item

Source: https://edgate.com/api/docs/content

Retrieves all metadata for a specific content item using its unique GUID.

```APIDOC
## GET /content/{GUID}

### Description
Retrieve all metadata for a specific content item.

### Method
GET

### Endpoint
/content/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the content item

### Response
#### Success Response (200)
This endpoint returns a single Content object (see Table 6 in the general content search documentation).

### Response Example
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "id": "item001",
  "title": "Example Content Title",
  "description": "This is a sample content item.",
  "url": "http://example.com/content/item001",
  "grade": ["5", "6"],
  "subject": ["Mathematics"],
  "content_set_id": 123,
  "metadata": [
    {"name": "author", "value": "John Doe"}
  ]
}
```

--------------------------------

### Get Child Concepts

Source: https://edgate.com/api/docs/concepts

Retrieves all child concepts for a given concept GUID.

```APIDOC
## GET /concepts/browse/{GUID}

### Description
Retrieve all child concepts for a specific concept GUID.

### Method
GET

### Endpoint
/concepts/browse/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the concept

### Response
#### Success Response (200)
- This endpoint returns a list of concept objects (See Table 12 in documentation).

### Response Example
```json
[
  {
    "guid": "child-guid-a",
    "name": "Child Concept A",
    "parent": {
      "guid": "parent-guid-1",
      "name": "Parent Concept 1"
    },
    "children": []
  }
]
```
```

--------------------------------

### Search Concepts (GET /concepts/)

Source: https://edgate.com/api/docs/concepts

Retrieves a list of concepts based on a search query. Supports pagination with 'limit' and 'offset' parameters. Returns a Concept Search Result JSON object.

```HTTP
GET /concepts/?q=science&limit=10&offset=20
```

--------------------------------

### Get Individual Standard Details

Source: https://edgate.com/api/docs/standards

This endpoint fetches detailed metadata for a specific standard using its unique GUID. The response includes information such as the standard's text, numbering, subject, grade level, adoption date, and modification timestamp. It also indicates if the standard has correlated materials.

```bash
GET /standards/{GUID}
```

--------------------------------

### Search Content Items (GET /content/)

Source: https://edgate.com/api/docs/content

Retrieves a list of content items based on search queries and filters. Supports pagination with limit and offset parameters. The response includes a status object, result count, and a list of content objects.

```HTTP
GET /content/?q=example&filters=grade|3,subject|math&limit=50&offset=100
```

--------------------------------

### Browse Top-Level Concepts (GET /concepts/browse)

Source: https://edgate.com/api/docs/concepts

Retrieves a list of all top-level nodes in the concept index. Returns a list of Concept JSON objects.

```HTTP
GET /concepts/browse
```

--------------------------------

### Get Standards Tagged with Concept

Source: https://edgate.com/api/docs/concepts

Retrieves standards that are tagged with a specific concept. Supports filtering by standards set and grade level.

```APIDOC
## GET /concepts/standards/{GUID}

### Description
Retrieves standards that are tagged with a specific concept.

### Method
GET

### Endpoint
/concepts/standards/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the concept
#### Query Parameters
- **set** (string) - Optional - ID of standards set to get standards for
- **grade** (string) - Optional - Grade level of standards

### Response
#### Success Response (200)
- This endpoint returns a list of Standards Group objects (See Table 4 in documentation).

### Response Example
```json
[
  {
    "standard_id": "std-123",
    "description": "Example standard description"
  }
]
```
```

--------------------------------

### View Available Metadata Filter Options (GET /content/filters)

Source: https://edgate.com/api/docs/content

Fetches a list of available metadata fields and their corresponding facet values with counts. This data can be used to refine searches using the content search endpoint.

```HTTP
GET /content/filters
```

--------------------------------

### View Metadata for a Single Content Item by Client ID (GET /content/byid/{ID})

Source: https://edgate.com/api/docs/content

Retrieves all metadata for a specific content item using a client-provided ID. Returns a single Content object.

```HTTP
GET /content/byid/{ID}
```

--------------------------------

### Get a list of standards from a specific set

Source: https://edgate.com/api/docs/standards

Retrieves all standards within a specific set, optionally filtered by subject area and grade level. Includes all parent and child standards.

```APIDOC
## Get a list of standards from a specific set

### Description
This endpoint returns a listing of all standards in a specific set for a given subject area and grade. This includes all parent and child level standards.

### Method
GET

### Endpoint
/standards/list/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the standard set to retrieve.

#### Query Parameters
- **subject** (string) - Optional - Subject area of standards.
- **grade** (string) - Optional - Grade level of standards.
- **correlate** (boolean) - Optional - Flag to show correlation status of the standards in response.

### Request Example
None

### Response
#### Success Response (200)
This returns a list of Standard JSON objects (see Table 3 in the main documentation for field definitions).

#### Response Example
[
  {
    "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "set": "common_core",
    "standard_number": "CCSS.ELA-Literacy.RL.4.1",
    "standard_text": "Refer to details and examples in text.",
    "label": "Grade 4 Reading Literature",
    "depth": 3,
    "subject": ["English Language Arts"],
    "grade": ["4"],
    "adopted": "2010-06",
    "modified": "2023-10-27 10:00:00-05:00",
    "parent": "a1b2c3d4-e5f6-7890-1234-567890abcde0",
    "children": ["a1b2c3d4-e5f6-7890-1234-567890abcdef1"],
    "metadata": [
      {
        "name": "Common Core Domain",
        "value": "Reading: Literature"
      }
    ],
    "correlated": true
  }
]
```

--------------------------------

### Generate HMAC-SHA256 Hash for EdGate API Authentication (PHP)

Source: https://edgate.com/api/docs/authentication

This PHP script demonstrates how to generate the HMAC-SHA256 hash required for authenticating requests to the EdGate API. It includes steps for obtaining a timestamp, constructing the parameter string, generating the hash using the private key, and setting the 'X-Hash' header for a cURL request. Ensure you replace 'example' and the private key with your actual credentials.

```php
<?php

//public and private keys

$publicKey = 'example';

$privateKey = '6a3c8fb1062285ee69d111ca77e6f72957e55dfa0e3ac277a5a5ef82c7ba6208';

//get current UNIX timestamp

$stamp = time();

//build parameter string, adding publicKey and timestamp

$parameters = "publicKey=".$publicKey."&timestamp=".$stamp."&param1=value1";

//generate HMAC hash of parameters

$hash = hash_hmac('sha256', $parameters, $privateKey);

//set header array for CURL, including X-Hash header

$headers = array(

    'X-Hash: '.$hash

);

//this example is a GET request, if POST/PUT/DELETE, parameters string would be set as the //request body

//set CURL options

$ch = curl_init('http://api.edgate.com/profile/?'.$parameters);

curl_setopt($ch,CURLOPT_HTTPHEADER,$headers);

curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);

//make request

$result = curl_exec($ch);

//close connection

curl_close($ch);

//decode response

$response = json_decode($result);

?>

```

--------------------------------

### Get Updated Standards Sets by Date Range (API)

Source: https://edgate.com/api/docs/standards

Fetches a list of standards sets updated within a specified date range. Results can be limited to a specific standards set and include change notes.

```HTTP
GET /standards/updates?start={start_date}&end={end_date}&set={set_id}
```

--------------------------------

### Profile API

Source: https://edgate.com/api/docs/packages

Provides access to user profile information. This endpoint is available under the 'Base' package.

```APIDOC
## GET /profile

### Description
Retrieves the user's profile information.

### Method
GET

### Endpoint
/profile

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **profile_data** (object) - Contains detailed profile information.

#### Response Example
```json
{
  "profile_data": {
    "user_id": "12345",
    "username": "example_user"
  }
}
```
```

--------------------------------

### Profile Resource API

Source: https://edgate.com/api/docs/index

Access which data sets and options are available through the Profile resource.

```APIDOC
## Profile Resource

### Description
Endpoints for accessing available data sets and options within the Profile resource.

### Method
GET

### Endpoint
`/profile`

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **data** (array) - List of available data sets and options.

#### Response Example
```json
{
  "data": [
    {
      "dataSetId": "123",
      "name": "Example Data Set",
      "options": [
        "option1",
        "option2"
      ]
    }
  ]
}
```
```

--------------------------------

### Content API

Source: https://edgate.com/api/docs/packages

Provides endpoints for searching, retrieving, and managing content items and sets, including content-related filtering and tagging. Add/Edit/Delete operations require the 'Premium I' package.

```APIDOC
## GET /content/search

### Description
Searches for content items based on various criteria.

### Method
GET

### Endpoint
/content/search

### Parameters
#### Path Parameters
None

#### Query Parameters
- **query** (string) - Required - The search query string.
- **filter** (string) - Optional - Filters results based on specific content attributes.
- **limit** (integer) - Optional - The maximum number of results to return.

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **search_results** (array) - A list of content items matching the search query.

#### Response Example
```json
{
  "search_results": [
    {
      "id": "CONT123",
      "title": "Introduction to Algebra"
    }
  ]
}
```
```

```APIDOC
## GET /content/filters

### Description
Retrieves available filters for content searches.

### Method
GET

### Endpoint
/content/filters

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **available_filters** (object) - An object containing different filter categories and their options.

#### Response Example
```json
{
  "available_filters": {
    "subjects": ["Math", "Science"],
    "grade_levels": ["K-2", "3-5"]
  }
}
```
```

```APIDOC
## GET /content/{content_id}

### Description
Retrieves details for a specific content item.

### Method
GET

### Endpoint
/content/{content_id}

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **content_details** (object) - Detailed information about the content item.

#### Response Example
```json
{
  "content_details": {
    "id": "CONT123",
    "title": "Introduction to Algebra",
    "description": "A basic introduction to algebraic concepts."
  }
}
```
```

```APIDOC
## GET /content/random

### Description
Retrieves a list of random content items.

### Method
GET

### Endpoint
/content/random

### Parameters
#### Path Parameters
None

#### Query Parameters
- **limit** (integer) - Optional - The number of random content items to retrieve.

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **random_content** (array) - A list of randomly selected content items.

#### Response Example
```json
{
  "random_content": [
    {
      "id": "CONT456",
      "title": "Photosynthesis Basics"
    }
  ]
}
```
```

```APIDOC
## POST /content/items

### Description
Adds a new content item. Requires 'Premium I' package.

### Method
POST

### Endpoint
/content/items

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **title** (string) - Required - The title of the content item.
- **description** (string) - Required - A description of the content item.

### Request Example
```json
{
  "title": "New Content Title",
  "description": "This is a description for the new content item."
}
```

### Response
#### Success Response (200)
- **content_id** (string) - The ID of the newly created content item.

#### Response Example
```json
{
  "content_id": "CONT789"
}
```
```

```APIDOC
## PUT /content/items/{content_id}

### Description
Updates an existing content item. Requires 'Premium I' package.

### Method
PUT

### Endpoint
/content/items/{content_id}

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item to update.

#### Query Parameters
None

#### Request Body
- **title** (string) - Optional - The new title for the content item.
- **description** (string) - Optional - The new description for the content item.

### Request Example
```json
{
  "description": "Updated description for the content item."
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the update was successful.

#### Response Example
```json
{
  "message": "Content item updated successfully."
}
```
```

```APIDOC
## DELETE /content/items/{content_id}

### Description
Deletes a content item. Requires 'Premium I' package.

### Method
DELETE

### Endpoint
/content/items/{content_id}

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item to delete.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for DELETE requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the deletion was successful.

#### Response Example
```json
{
  "message": "Content item deleted successfully."
}
```
```

```APIDOC
## GET /content/{content_id}/related

### Description
Retrieves content items related to a given content item.

### Method
GET

### Endpoint
/content/{content_id}/related

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **related_content** (array) - A list of related content items.

#### Response Example
```json
{
  "related_content": [
    {
      "id": "CONT987",
      "title": "Advanced Algebra Topics"
    }
  ]
}
```
```

```APIDOC
## POST /content/items/{content_id}/tags

### Description
Adds a concept tag to a content item. Requires 'Premium I' package.

### Method
POST

### Endpoint
/content/items/{content_id}/tags

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.

#### Query Parameters
None

#### Request Body
- **concept_id** (string) - Required - The unique identifier of the concept to tag.

### Request Example
```json
{
  "concept_id": "CON99"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the tag was added successfully.

#### Response Example
```json
{
  "message": "Concept tag added successfully."
}
```
```

```APIDOC
## DELETE /content/items/{content_id}/tags/{concept_id}

### Description
Removes a concept tag from a content item. Requires 'Premium I' package.

### Method
DELETE

### Endpoint
/content/items/{content_id}/tags/{concept_id}

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.
- **concept_id** (string) - Required - The unique identifier of the concept tag to remove.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for DELETE requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the tag was removed successfully.

#### Response Example
```json
{
  "message": "Concept tag removed successfully."
}
```
```

```APIDOC
## GET /content/{content_id}/concepts

### Description
Retrieves concepts associated with a specific content item.

### Method
GET

### Endpoint
/content/{content_id}/concepts

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **concepts** (array) - A list of concepts linked to the content item.

#### Response Example
```json
{
  "concepts": [
    {
      "id": "CON55",
      "name": "Algebraic Expressions"
    }
  ]
}
```
```

```APIDOC
## POST /content/sets

### Description
Adds a new content set. Requires 'Premium I' package.

### Method
POST

### Endpoint
/content/sets

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the content set.
- **description** (string) - Optional - A description of the content set.

### Request Example
```json
{
  "name": "Math Basics Set",
  "description": "A collection of introductory math content."
}
```

### Response
#### Success Response (200)
- **set_id** (string) - The ID of the newly created content set.

#### Response Example
```json
{
  "set_id": "SET001"
}
```
```

```APIDOC
## PUT /content/sets/{set_id}

### Description
Updates an existing content set. Requires 'Premium I' package.

### Method
PUT

### Endpoint
/content/sets/{set_id}

### Parameters
#### Path Parameters
- **set_id** (string) - Required - The unique identifier of the content set to update.

#### Query Parameters
None

#### Request Body
- **name** (string) - Optional - The new name for the content set.
- **description** (string) - Optional - The new description for the content set.

### Request Example
```json
{
  "description": "Updated description for Math Basics Set."
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the update was successful.

#### Response Example
```json
{
  "message": "Content set updated successfully."
}
```
```

```APIDOC
## DELETE /content/sets/{set_id}

### Description
Deletes a content set. Requires 'Premium I' package.

### Method
DELETE

### Endpoint
/content/sets/{set_id}

### Parameters
#### Path Parameters
- **set_id** (string) - Required - The unique identifier of the content set to delete.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for DELETE requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the deletion was successful.

#### Response Example
```json
{
  "message": "Content set deleted successfully."
}
```
```

```APIDOC
## GET /content/keywords/suggested

### Description
Retrieves suggested key terms for content analysis.

### Method
GET

### Endpoint
/content/keywords/suggested

### Parameters
#### Path Parameters
None

#### Query Parameters
- **text** (string) - Required - The text to analyze for key terms.

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **suggested_keywords** (array) - A list of suggested key terms.

#### Response Example
```json
{
  "suggested_keywords": ["algebra", "equations", "variables"]
}
```
```

```APIDOC
## POST /content/items/{content_id}/autocorrelate

### Description
Automatically correlates a content item with standards or concepts. Requires 'Premium I' package.

### Method
POST

### Endpoint
/content/items/{content_id}/autocorrelate

### Parameters
#### Path Parameters
- **content_id** (string) - Required - The unique identifier of the content item.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for this POST request, assumes automatic correlation based on content item)

### Response
#### Success Response (200)
- **correlation_results** (object) - Results of the automatic correlation.

#### Response Example
```json
{
  "correlation_results": {
    "correlated_standards": ["STD101"],
    "correlated_concepts": ["CON1"]
  }
}
```
```

--------------------------------

### POST /content/sets - Create Content Sets

Source: https://edgate.com/api/docs/content

Allows the client to create one or more content sets within the repository. All content sets must have a unique name. The request body must be a JSON array of content set names.

```APIDOC
## POST /content/sets

### Description
Allows the client to create one or more content sets within the repository. All content sets must have a unique name.

### Method
POST

### Endpoint
/content/sets

### Parameters
#### Request Body
- **set_name** (List of string) - Required - List of new content set names. If only one set is being created, the body must be a JSON array.

### Request Example
```json
{
  "set_name": [
    "Math - Algebra",
    "Science - Biology"
  ]
}
```

### Response
#### Success Response (200)
Returns a list of content set submission status objects (see Table 11), corresponding to the number of sets created. Each object gives a status of whether or not the item was saved successfully and a GUID for the item, if successful.

**Table 11 - Content Set Submission Status object**
- **status** (integer) - Status code for submission
- **message** (string) - Status message
- **set_id** (string) - ID of new content set created

#### Response Example
```json
[
  {
    "status": 0,
    "message": "Success",
    "set_id": "set-12345"
  },
  {
    "status": 0,
    "message": "Success",
    "set_id": "set-67890"
  }
]
```
```

--------------------------------

### GET /concepts/related/{GUID}

Source: https://edgate.com/api/docs/concepts

Retrieve concepts that are related to a specific concept GUID. This endpoint helps in discovering semantically linked concepts.

```APIDOC
## GET /concepts/related/{GUID}

### Description
Retrieve related concepts for a specific concept GUID.

### Method
GET

### Endpoint
/concepts/related/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - GUID of the concept

### Response
#### Success Response (200)
- This endpoint returns a list of concept objects (See Table 12).

#### Response Example
```json
{
  "related_concepts": [
    {
      "id": "related_concept_guid_1",
      "name": "Related Concept 1"
    },
    {
      "id": "related_concept_guid_2",
      "name": "Related Concept 2"
    }
  ]
}
```
```

--------------------------------

### Concepts API

Source: https://edgate.com/api/docs/packages

Provides endpoints for searching, browsing, and retrieving information about concepts, including their relationships with standards and content. Access to concept endpoints requires 'Premium II' package.

```APIDOC
## GET /concepts/search

### Description
Searches for concepts based on a query.

### Method
GET

### Endpoint
/concepts/search

### Parameters
#### Path Parameters
None

#### Query Parameters
- **query** (string) - Required - The search query for
```

--------------------------------

### Get Correlated Content for Standard (GET Request)

Source: https://edgate.com/api/docs/correlation

This GET request finds content items correlated to an individual standard. Content results can be filtered and paged through using 'filters', 'limit', and 'offset' query parameters. The 'guid' parameter is required in the path.

```http
GET /correlations/standard/{GUID}?filters={filter_pairs}&limit={limit_count}&offset={offset_number} HTTP/1.1
Host: api.example.com
```

--------------------------------

### Concepts Resource API

Source: https://edgate.com/api/docs/index

Search, browse, and view curricular concepts using the Concepts resource.

```APIDOC
## Concepts Resource

### Description
Endpoints for searching, browsing, and viewing curricular concepts.

### Method
GET

### Endpoint
`/concepts`

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for concepts.
- **browse** (boolean) - Optional - Set to true to browse concepts.

### Request Example
```json
{
  "query": "geometry",
  "browse": false
}
```

### Response
#### Success Response (200)
- **concepts** (array) - List of curricular concepts.

#### Response Example
```json
{
  "concepts": [
    {
      "id": "concept-abc",
      "name": "Geometric Shapes",
      "description": "Basic shapes in geometry."
    }
  ]
}
```
```

--------------------------------

### Standards Resource API

Source: https://edgate.com/api/docs/index

Search, browse, and view curriculum standards using the Standards resource.

```APIDOC
## Standards Resource

### Description
Endpoints for searching, browsing, and viewing curriculum standards.

### Method
GET

### Endpoint
`/standards`

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for standards.
- **browse** (boolean) - Optional - Set to true to browse standards.

### Request Example
```json
{
  "query": "mathematics",
  "browse": false
}
```

### Response
#### Success Response (200)
- **standards** (array) - List of curriculum standards.

#### Response Example
```json
{
  "standards": [
    {
      "id": "std-001",
      "title": "Grade 5 Math Standards",
      "description": "Standards for mathematics in Grade 5."
    }
  ]
}
```
```
Tokens:
Raw