How to Create Articles with the Joomla 6 REST API

Last Updated on August 9, 2026

Joomla 6 includes powerful web services that allow developers to communicate with a Joomla website through a REST API. Instead of creating and managing articles manually from the Joomla administrator panel, you can use the API to create articles programmatically from applications, scripts, mobile apps, or external systems.

In this tutorial, you will learn how to create articles with the Joomla 6 REST API step by step. We will look at the API endpoint, authentication, required fields, request headers, JSON data, and a practical example using cURL and Postman.

This guide is especially useful for Joomla developers who want to automate content creation or connect Joomla 6 with another application.

What Is the Joomla 6 REST API?

The Joomla 6 REST API provides a way for external applications to communicate with Joomla using HTTP requests. Instead of interacting directly with the Joomla database, an application can send requests to Joomla’s API endpoints.

For example, you can use the REST API to:

• Create Joomla articles
• Update existing articles
• Retrieve articles
• Delete articles
• Manage users and other supported resources
• Connect Joomla with external applications
• Automate repetitive content-management tasks

For creating an article, your external application sends a POST request containing the article information to the Joomla API.

Before working with the REST API, it is helpful to understand how Joomla 6 Web Services work and how they allow external applications to communicate with your Joomla website. You can learn more in our complete guide to Joomla 6 Web Services.

What Do You Need Before Creating an Article?

Before making your first API request, you should have a working Joomla 6 website and access to a Joomla user account that is allowed to use the API.

You will also need an API authentication token. Joomla 6 provides API authentication through the Web Services API and user API tokens.

Make sure you have the following:

• A Joomla 6 website
• A Joomla user account with appropriate permissions
• An API token
• The article category ID
• The Joomla API URL
• A tool such as Postman, cURL, or another HTTP client

Find Your Joomla 6 API URL

The Joomla API is normally accessed through the /api/index.php endpoint of your website.

For example, if your website is:

https://example.com

your API base URL will generally be:

https://example.com/api/index.php

The exact endpoint used for creating an article depends on the Joomla API resource you are working with.

Enable API Authentication in Joomla 6

Authentication is important because Joomla must know which user is making the API request. You should not expose article-creation functionality to unauthenticated users.

Open the Joomla Administrator

Log in to your Joomla 6 administrator dashboard.

Go to:

System → Manage → Plugins

Search for the Joomla API or authentication-related plugins required by your Joomla installation and make sure the appropriate Web Services and API authentication plugins are enabled.

Joomla API authentication is an important part of working with protected resources. For a detailed explanation, see our guide on Joomla 6 Web Services and API Authentication.

Create or Find the User API Token

Open the Joomla user account that you want to use for API access.

Depending on your Joomla configuration, the API token can be managed from the user’s account settings. Copy the generated token and keep it secure.

Important: Never publish your API token in a blog post, GitHub repository, JavaScript file, or publicly accessible source code.

For additional technical details about Joomla Web Services and API authentication, refer to the official Joomla API Specification.

How to Create Articles with the Joomla 6 REST API

Now let’s look at the actual process of creating an article.

The basic workflow is:

1. Authenticate your request.
2. Send a POST request to the article API endpoint.
3. Provide the article data as JSON.
4. Joomla validates the request.
5. Joomla creates the article if the user has sufficient permissions.
6. The API returns the result.

Prepare the Article Data

An article request normally needs information such as the article title, alias, category, and article body.

A simple JSON request can look similar to the following:

{
  "title": "My First Joomla 6 API Article",
  "alias": "my-first-joomla-6-api-article",
  "catid": 2,
  "articletext": "<p>This article was created using the Joomla 6 REST API.</p>",
  "state": 1
}

The exact fields accepted by an endpoint can vary, so you should always verify the resource definition for the Joomla version and API endpoint you are using.

Use Postman to Create a Joomla Article

Postman is one of the easiest tools for testing REST APIs. It allows you to create requests without writing a complete application.

Open Postman and create a new request.

Set the HTTP method to:

POST

Then enter your Joomla API article endpoint.

Your request URL will be based on your Joomla website, for example:

https://example.com/api/index.php/v1/content/articles

Make sure you use the correct endpoint for your Joomla 6 installation and API configuration.

Add the Authorization Header

Next, add the API token to the request authentication header.

A common token-based request uses an Authorization header similar to:

Authorization: Bearer YOUR_API_TOKEN

Replace YOUR_API_TOKEN with your actual Joomla API token.

You should also send JSON content:

Content-Type: application/json

For example, the headers may look like:

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Add the JSON Request Body

In Postman, select Body, choose raw, and select JSON as the format.

You can then provide your article information, for example:

{
  "title": "Joomla 6 REST API Tutorial",
  "alias": "joomla-6-rest-api-tutorial",
  "catid": 2,
  "articletext": "<p>This article was created automatically through the Joomla 6 REST API.</p>",
  "state": 1
}

Click Send to submit the request.

If your authentication, endpoint, permissions, and request data are correct, Joomla should process the request and return a response containing information about the created article.

If you are new to API testing, check our step-by-step guide on How to Test Joomla 6 REST API Using Postman before creating your first article request.

Create a Joomla 6 Article Using cURL

If you prefer working from the command line, you can also use cURL to send the request.

A basic example looks like this:

curl -X POST "https://example.com/api/index.php/v1/content/articles" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "title": "Article Created with Joomla 6 API",
  "alias": "article-created-with-joomla-6-api",
  "catid": 2,
  "articletext": "<p>This article was created using the Joomla 6 REST API.</p>",
  "state": 1
}'

Replace example.com with your website domain and replace YOUR_API_TOKEN with your actual API token.

You should also replace the category ID with a category that exists on your Joomla website.

Understanding the Important Article Fields

When working with the Joomla REST API, it is useful to understand the purpose of the main article fields.

Title

The title field contains the name of your article.

"title": "My Joomla 6 Article"

This is the title visitors will normally see when viewing the article.

Alias

The alias is used to create a URL-friendly identifier for the article.

"alias": "my-joomla-6-article"

Using a clean alias can help make article URLs easier for users and search engines to understand.

Category ID

The catid identifies the Joomla category where the article should be stored.

"catid": 2

You must use a valid category ID from your Joomla website.

Article Text

The articletext field contains the main content of the article.

"articletext": "<p>Hello from the Joomla REST API.</p>"

Because article content can contain HTML, make sure the JSON is correctly formatted and escaped.

Article State

The article state determines whether the article is published or not, depending on the API resource’s accepted values and Joomla’s publishing rules.

For example, a request may contain:

"state": 1

Always test publishing behavior carefully, especially when using an API to automatically publish content on a production website.

Because API requests operate through Joomla user permissions, understanding Joomla users and access control is important. You can also read our guide on How to Create Users in Joomla 6.

Common Joomla 6 REST API Errors

While testing the Joomla 6 REST API, you may encounter errors. Understanding the HTTP response can make troubleshooting much easier.

404 Resource Not Found

A 404 Resource not found response usually means that the URL or API endpoint is incorrect, unavailable, or not registered as expected.

Check your API URL carefully and make sure you are using the correct Joomla API endpoint.

403 Forbidden

A 403 Forbidden response generally indicates that Joomla understood the request but does not allow the current user to perform the requested operation.

Check the following:

• API token
• User permissions
• Access levels
• ACL permissions
• Required API plugins
• Category permissions

401 Unauthorized

A 401 Unauthorized response normally indicates an authentication problem.

Verify that the Authorization header is present and that the API token is correct.

400 Bad Request

A 400 Bad Request response can occur when the JSON data is invalid or required article information is missing.

Check your JSON syntax and compare your request with the fields expected by the Joomla API endpoint.

You can also learn more about API testing from the official Postman API Testing guide, which covers testing API endpoints, integrations, and responses.

Security Tips for the Joomla 6 REST API

API access should be treated as carefully as administrator access. Anyone who obtains a powerful API token may be able to perform actions allowed to that user.

• Never share API tokens publicly.
• Do not put tokens directly into frontend JavaScript.
• Use HTTPS for API communication.
• Give API users only the permissions they actually need.
• Regenerate or revoke tokens if they are exposed.
• Test API integrations on a development website before using them on production.

Why Use the Joomla 6 REST API to Create Articles?

Using the REST API can save considerable time when articles need to be created automatically or imported from another system.

For example, a company could have an external application that collects product information and automatically sends it to Joomla. A developer could also create an internal content-management tool that communicates with Joomla without requiring users to work directly inside the Joomla administrator interface.

The API can therefore be useful for automation, integrations, custom applications, mobile applications, and content-import workflows.

Once you understand how to create Joomla articles through the API, you can combine API requests with Joomla automation to build more advanced workflows. Our Joomla 6 Scheduler tutorial explains how scheduled tasks can automate Joomla processes.

Conclusion

Learning how to create articles with the Joomla 6 REST API opens up many possibilities for Joomla automation and integration. Instead of manually creating every article through the administrator dashboard, developers can send authenticated API requests containing the required article information.

In this guide, we covered the basic process of preparing Joomla 6, authenticating an API request, sending article data as JSON, using Postman, using cURL, understanding important article fields, and troubleshooting common API errors.

If you are developing a Joomla 6 integration, start by testing your requests with Postman. Once the API request works correctly, you can move the same logic into PHP, JavaScript, Python, or another application that communicates with your Joomla website.

Frequently Asked Questions About Joomla 6 REST API