Blog API Documentation

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

ai-blog

api > blog-requests > list

GET /ai-blog/api/blog-requests/

API endpoint for AI blog requests

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests list -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; list"]
var params = {
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; list"]
params = {
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > create

POST /ai-blog/api/blog-requests/

API endpoint for AI blog requests

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required	The title for the blog post
`topic` required	Main topic of the blog
`keywords` required	SEO keywords separated by commas
`description` required	Brief description of what the blog should cover
`tone`	Tone of the blog (professional, casual, technical, etc.)
`target_audience`	Target audience for the blog
`word_count`	Target word count for the generated blog
`project` required
`category`
`tags`
`temperature`	Controls randomness (0.0-1.0)
`max_tokens`	Maximum tokens for AI response
`include_faqs`	Include FAQ section in the generated blog
`include_table_of_contents`	Include table of contents in the generated blog
`image_prompt`	Optional master prompt for all images. If left blank, the AI will create custom prompts for each image.
`image_aspect_ratio`	Aspect ratio for generated images

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests create -p title=... -p topic=... -p keywords=... -p description=... -p tone=... -p target_audience=... -p word_count=... -p project=... -p category=... -p tags=... -p temperature=... -p max_tokens=... -p include_faqs=... -p include_table_of_contents=... -p image_prompt=... -p image_aspect_ratio=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; create"]
var params = {
    title: ...,
    topic: ...,
    keywords: ...,
    description: ...,
    tone: ...,
    target_audience: ...,
    word_count: ...,
    project: ...,
    category: ...,
    tags: ...,
    temperature: ...,
    max_tokens: ...,
    include_faqs: ...,
    include_table_of_contents: ...,
    image_prompt: ...,
    image_aspect_ratio: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; create"]
params = {
    "title": ...,
    "topic": ...,
    "keywords": ...,
    "description": ...,
    "tone": ...,
    "target_audience": ...,
    "word_count": ...,
    "project": ...,
    "category": ...,
    "tags": ...,
    "temperature": ...,
    "max_tokens": ...,
    "include_faqs": ...,
    "include_table_of_contents": ...,
    "image_prompt": ...,
    "image_aspect_ratio": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > read

GET /ai-blog/api/blog-requests/{id}/

API endpoint for AI blog requests

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests read -p id=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; read"]
params = {
    "id": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > update

PUT /ai-blog/api/blog-requests/{id}/

API endpoint for AI blog requests

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required	The title for the blog post
`topic` required	Main topic of the blog
`keywords` required	SEO keywords separated by commas
`description` required	Brief description of what the blog should cover
`tone`	Tone of the blog (professional, casual, technical, etc.)
`target_audience`	Target audience for the blog
`word_count`	Target word count for the generated blog
`project` required
`category`
`tags`
`temperature`	Controls randomness (0.0-1.0)
`max_tokens`	Maximum tokens for AI response
`include_faqs`	Include FAQ section in the generated blog
`include_table_of_contents`	Include table of contents in the generated blog
`image_prompt`	Optional master prompt for all images. If left blank, the AI will create custom prompts for each image.
`image_aspect_ratio`	Aspect ratio for generated images

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests update -p id=... -p title=... -p topic=... -p keywords=... -p description=... -p tone=... -p target_audience=... -p word_count=... -p project=... -p category=... -p tags=... -p temperature=... -p max_tokens=... -p include_faqs=... -p include_table_of_contents=... -p image_prompt=... -p image_aspect_ratio=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; update"]
var params = {
    id: ...,
    title: ...,
    topic: ...,
    keywords: ...,
    description: ...,
    tone: ...,
    target_audience: ...,
    word_count: ...,
    project: ...,
    category: ...,
    tags: ...,
    temperature: ...,
    max_tokens: ...,
    include_faqs: ...,
    include_table_of_contents: ...,
    image_prompt: ...,
    image_aspect_ratio: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; update"]
params = {
    "id": ...,
    "title": ...,
    "topic": ...,
    "keywords": ...,
    "description": ...,
    "tone": ...,
    "target_audience": ...,
    "word_count": ...,
    "project": ...,
    "category": ...,
    "tags": ...,
    "temperature": ...,
    "max_tokens": ...,
    "include_faqs": ...,
    "include_table_of_contents": ...,
    "image_prompt": ...,
    "image_aspect_ratio": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > partial_update

PATCH /ai-blog/api/blog-requests/{id}/

API endpoint for AI blog requests

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title`	The title for the blog post
`topic`	Main topic of the blog
`keywords`	SEO keywords separated by commas
`description`	Brief description of what the blog should cover
`tone`	Tone of the blog (professional, casual, technical, etc.)
`target_audience`	Target audience for the blog
`word_count`	Target word count for the generated blog
`project`
`category`
`tags`
`temperature`	Controls randomness (0.0-1.0)
`max_tokens`	Maximum tokens for AI response
`include_faqs`	Include FAQ section in the generated blog
`include_table_of_contents`	Include table of contents in the generated blog
`image_prompt`	Optional master prompt for all images. If left blank, the AI will create custom prompts for each image.
`image_aspect_ratio`	Aspect ratio for generated images

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests partial_update -p id=... -p title=... -p topic=... -p keywords=... -p description=... -p tone=... -p target_audience=... -p word_count=... -p project=... -p category=... -p tags=... -p temperature=... -p max_tokens=... -p include_faqs=... -p include_table_of_contents=... -p image_prompt=... -p image_aspect_ratio=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; partial_update"]
var params = {
    id: ...,
    title: ...,
    topic: ...,
    keywords: ...,
    description: ...,
    tone: ...,
    target_audience: ...,
    word_count: ...,
    project: ...,
    category: ...,
    tags: ...,
    temperature: ...,
    max_tokens: ...,
    include_faqs: ...,
    include_table_of_contents: ...,
    image_prompt: ...,
    image_aspect_ratio: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; partial_update"]
params = {
    "id": ...,
    "title": ...,
    "topic": ...,
    "keywords": ...,
    "description": ...,
    "tone": ...,
    "target_audience": ...,
    "word_count": ...,
    "project": ...,
    "category": ...,
    "tags": ...,
    "temperature": ...,
    "max_tokens": ...,
    "include_faqs": ...,
    "include_table_of_contents": ...,
    "image_prompt": ...,
    "image_aspect_ratio": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > delete

DELETE /ai-blog/api/blog-requests/{id}/

API endpoint for AI blog requests

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests delete -p id=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; delete"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; delete"]
params = {
    "id": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > generate

POST /ai-blog/api/blog-requests/{id}/generate/

API endpoint to generate a blog

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required	The title for the blog post
`topic` required	Main topic of the blog
`keywords` required	SEO keywords separated by commas
`description` required	Brief description of what the blog should cover
`tone`	Tone of the blog (professional, casual, technical, etc.)
`target_audience`	Target audience for the blog
`word_count`	Target word count for the generated blog
`project` required
`category`
`tags`
`temperature`	Controls randomness (0.0-1.0)
`max_tokens`	Maximum tokens for AI response
`include_faqs`	Include FAQ section in the generated blog
`include_table_of_contents`	Include table of contents in the generated blog
`image_prompt`	Optional master prompt for all images. If left blank, the AI will create custom prompts for each image.
`image_aspect_ratio`	Aspect ratio for generated images

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests generate -p id=... -p title=... -p topic=... -p keywords=... -p description=... -p tone=... -p target_audience=... -p word_count=... -p project=... -p category=... -p tags=... -p temperature=... -p max_tokens=... -p include_faqs=... -p include_table_of_contents=... -p image_prompt=... -p image_aspect_ratio=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; generate"]
var params = {
    id: ...,
    title: ...,
    topic: ...,
    keywords: ...,
    description: ...,
    tone: ...,
    target_audience: ...,
    word_count: ...,
    project: ...,
    category: ...,
    tags: ...,
    temperature: ...,
    max_tokens: ...,
    include_faqs: ...,
    include_table_of_contents: ...,
    image_prompt: ...,
    image_aspect_ratio: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; generate"]
params = {
    "id": ...,
    "title": ...,
    "topic": ...,
    "keywords": ...,
    "description": ...,
    "tone": ...,
    "target_audience": ...,
    "word_count": ...,
    "project": ...,
    "category": ...,
    "tags": ...,
    "temperature": ...,
    "max_tokens": ...,
    "include_faqs": ...,
    "include_table_of_contents": ...,
    "image_prompt": ...,
    "image_aspect_ratio": ...,
}
result = client.action(schema, action, params=params)

api > blog-requests > status

GET /ai-blog/api/blog-requests/{id}/status/

API endpoint to check blog generation status

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this AI Blog Request.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api blog-requests status -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; blog-requests &gt; status"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; blog-requests &gt; status"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

api > generated-images > list

GET /ai-blog/api/generated-images/

API endpoint for generated images

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api generated-images list -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; generated-images &gt; list"]
var params = {
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; generated-images &gt; list"]
params = {
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api > generated-images > read

GET /ai-blog/api/generated-images/{id}/

API endpoint for generated images

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this generated image.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action ai-blog api generated-images read -p id=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ai-blog", "api &gt; generated-images &gt; read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["ai-blog", "api &gt; generated-images &gt; read"]
params = {
    "id": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

api

blogs > list

GET /api/blogs/

API endpoint for listing blogs

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api blogs list -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "blogs &gt; list"]
var params = {
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "blogs &gt; list"]
params = {
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

blogs > read

GET /api/blogs/{slug}/

API endpoint for retrieving a specific blog

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api blogs read -p slug=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "blogs &gt; read"]
var params = {
    slug: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "blogs &gt; read"]
params = {
    "slug": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

blogs > analysis > list

GET /api/blogs/{slug}/analysis/

Endpoint to get SEO analysis for a blog post

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api blogs analysis list -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "blogs &gt; analysis &gt; list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "blogs &gt; analysis &gt; list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

blogs > canonical > list

GET /api/blogs/{slug}/canonical/

Endpoint to get canonical URL for a blog post, useful for handling redirects

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api blogs canonical list -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "blogs &gt; canonical &gt; list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "blogs &gt; canonical &gt; list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

GET /api/blogs/{slug}/related/

Get related content for a blog post based on tags, category, and explicitly set relations

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api blogs related list -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "blogs &gt; related &gt; list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "blogs &gt; related &gt; list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

GET /api/categories/

API endpoint for categories

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api categories list -p page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "categories &gt; list"]
var params = {
    page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "categories &gt; list"]
params = {
    "page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

categories > read

GET /api/categories/{slug}/

API endpoint for categories

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api categories read -p slug=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "categories &gt; read"]
var params = {
    slug: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "categories &gt; read"]
params = {
    "slug": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

categories > blogs > list

GET /api/categories/{slug}/blogs/

API endpoint for listing blogs by category

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api categories blogs list -p slug=... -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "categories &gt; blogs &gt; list"]
var params = {
    slug: ...,
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "categories &gt; blogs &gt; list"]
params = {
    "slug": ...,
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

popular > list

GET /api/popular/

Get popular blogs, optionally filtered by project This is a placeholder - in a real implementation, this would factor in view counts, social shares, and other metrics to determine popularity

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api popular list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "popular &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "popular &gt; list"]
result = client.action(schema, action)

popular > project > read

GET /api/popular/project/{project_slug}/

Get popular blogs, optionally filtered by project This is a placeholder - in a real implementation, this would factor in view counts, social shares, and other metrics to determine popularity

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api popular project read -p project_slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "popular &gt; project &gt; read"]
var params = {
    project_slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "popular &gt; project &gt; read"]
params = {
    "project_slug": ...,
}
result = client.action(schema, action, params=params)

projects > list

GET /api/projects/

API endpoint for projects

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects list -p page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; list"]
var params = {
    page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; list"]
params = {
    "page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

projects > find_by_url

GET /api/projects/find_by_url/

Find projects by website URL

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects find_by_url

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; find_by_url"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; find_by_url"]
result = client.action(schema, action)

projects > read

GET /api/projects/{slug}/

API endpoint for projects

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects read -p slug=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; read"]
var params = {
    slug: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; read"]
params = {
    "slug": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

projects > stats

GET /api/projects/{slug}/stats/

Returns statistics for a project

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects stats -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; stats"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; stats"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

projects > stats_0

GET /api/projects/{slug}/stats/

Returns statistics for a project

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects stats_0 -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; stats_0"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; stats_0"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

projects > blogs > list

GET /api/projects/{slug}/blogs/

API endpoint for listing blogs by project

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api projects blogs list -p slug=... -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "projects &gt; blogs &gt; list"]
var params = {
    slug: ...,
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "projects &gt; blogs &gt; list"]
params = {
    "slug": ...,
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

seo > settings > list

GET /api/seo/settings/

API endpoint for retrieving global SEO settings

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api seo settings list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "seo &gt; settings &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "seo &gt; settings &gt; list"]
result = client.action(schema, action)

seo > sitemap > list

GET /api/seo/sitemap/

API endpoint to get data for generating a sitemap

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api seo sitemap list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "seo &gt; sitemap &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "seo &gt; sitemap &gt; list"]
result = client.action(schema, action)

tags > list

GET /api/tags/

API endpoint for tags

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api tags list -p page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "tags &gt; list"]
var params = {
    page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "tags &gt; list"]
params = {
    "page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

tags > read

GET /api/tags/{slug}/

API endpoint for tags

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api tags read -p slug=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "tags &gt; read"]
var params = {
    slug: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "tags &gt; read"]
params = {
    "slug": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

tags > blogs > list

GET /api/tags/{slug}/blogs/

API endpoint for listing blogs by tag

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://5.161.74.169:9005/docs/

# Interact with the API endpoint
$ coreapi action api tags blogs list -p slug=... -p page=... -p search=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "tags &gt; blogs &gt; list"]
var params = {
    slug: ...,
    page: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://5.161.74.169:9005/docs/")

# Interact with the API endpoint
action = ["api", "tags &gt; blogs &gt; list"]
params = {
    "slug": ...,
    "page": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)