Supports high-speed streaming output, multi-turn dialogues, internet search, long document reading, image analysis, zero-configuration deployment, multi-token support, and automatic session trace cleanup.
Fully compatible with the ChatGPT interface.
Also, the following free APIs are available for your attention:
Moonshot AI (Kimi.ai) API to API kimi-free-api
StepFun (StepChat) API to API step-free-api
Ali Tongyi (Qwen) API to API qwen-free-api
ZhipuAI (ChatGLM) API to API glm-free-api
ByteDance (Doubao) API to API doubao-free-api
ByteDance (Jimeng) API to API jimeng-free-api
Meta Sota (metaso) API to API metaso-free-api
Iflytek Spark (Spark) API to API spark-free-api
Lingxin Intelligence (Emohaa) API to API emohaa-free-api (OUT OF ORDER)
- Announcement
- Effect Examples
- Access preparation
- Docker Deployment
- Native Deployment
- Recommended Clients
- Interface List
- Precautions
- Star History
This API is unstable. So we highly recommend you go to the StepChat use the offical API, avoiding banned.
This organization and individuals do not accept any financial donations and transactions. This project is purely for research, communication, and learning purposes!
For personal use only, it is forbidden to provide services or commercial use externally to avoid causing service pressure on the official, otherwise, bear the risk yourself!
For personal use only, it is forbidden to provide services or commercial use externally to avoid causing service pressure on the official, otherwise, bear the risk yourself!
For personal use only, it is forbidden to provide services or commercial use externally to avoid causing service pressure on the official, otherwise, bear the risk yourself!
Obtain deviceId and Oasis-Token from yuewen.cn
Enter StepChat and start a random conversation, then press F12 to open the developer tools.
-
Find the value of
deviceIdin Application > LocalStorage (remove quotation marks), for example:267bcc81a01c2032a11a3fc6ec3e372c380eb9d1
-
Find the value of
Oasis-Tokenin Application > Cookies, for example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
-
Concatenate
deviceIdandOasis-Tokenusing@to create the Token, which will be used as the Bearer Token value for Authorization:Authorization: Bearer 267bcc81a01c2032a11a3fc6ec3e372c380eb9d1@eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
You can provide multiple account refresh_tokens and use , to join them:
Authorization: Bearer TOKEN1,TOKEN2,TOKEN3
The service will pick one each time a request is made.
Please prepare a server with a public IP and open port 8000.
Pull the image and start the service
docker run -it -d --init --name step-free-api -p 8000:8000 -e TZ=Asia/Shanghai vinlic/step-free-api:latestcheck real-time service logs
docker logs -f step-free-apiRestart service
docker restart step-free-apiShut down service
docker stop step-free-apiversion: '3'
services:
step-free-api:
container_name: step-free-api
image: vinlic/step-free-api:latest
restart: always
ports:
- "8000:8000"
environment:
- TZ=Asia/ShanghaiAttention: Some deployment regions may not be able to connect to Kimi. If container logs show request timeouts or connection failures (Singapore has been tested and found unavailable), please switch to another deployment region!
Attention: Container instances for free accounts will automatically stop after a period of inactivity, which may result in a 50-second or longer delay during the next request. It is recommended to check Render Container Keepalive
-
Fork this project to your GitHub account.
-
Visit Render and log in with your GitHub account.
-
Build your Web Service (
New+->Build and deploy from a Git repository->Connect your forked project->Select deployment region->Choose instance type as Free->Create Web Service). -
After the build is complete, copy the assigned domain and append the URL to access it.
Note: Vercel free accounts have a request response timeout of 10 seconds, but interface responses are usually longer, which may result in a 504 timeout error from Vercel!
Please ensure that Node.js environment is installed first.
npm i -g vercel --registry http://registry.npmmirror.com
vercel login
git clone https://github.com/LLM-Red-Team/step-free-api
cd step-free-api
vercel --prod
Please prepare a server with a public IP and open port 8000.
Please install the Node.js environment and configure the environment variables first, and confirm that the node command is available.
Install dependencies
npm iInstall PM2 for process guarding
npm i -g pm2Compile and build. When you see the dist directory, the build is complete.
npm run buildStart service
pm2 start dist/index.js --name "step-free-api"View real-time service logs
pm2 logs step-free-apiRestart service
pm2 reload step-free-apiShut down service
pm2 stop step-free-apiUsing the following second-developed clients for free-api series projects is faster and easier, and supports document/image uploads!
Clivia's modified LobeChat https://github.com/Yanyutin753/lobe-chat
Time@'s modified ChatGPT Web https://github.com/SuYxh/chatgpt-web-sea
Currently, the /v1/chat/completions interface compatible with openai is supported. You can use the client access interface compatible with openai or other clients, or use online services such as dify Access and use.
Conversation completion interface, compatible with openai's chat-completions-api.
POST /v1/chat/completions
The header needs to set the Authorization header:
Authorization: Bearer [refresh_token]
Request data:
{
// Fill in the model name as you like.
"model": "step",
"messages": [
{
"role": "user",
"content": "你是谁？"
}
],
// If using SSE stream, please set it to true, the default is false
"stream": false
}Response data:
{
"id": "85466015488159744",
"model": "step",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "I am StepChat, a large multimodal model developed by StepFun. I can answer your questions, provide information and help, as well as support multimodal interactions such as text, images, etc. If you have any questions or need help, please feel free to ask me."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 2
},
"created": 1711829974
}Provide an accessible file URL or BASE64_URL to parse.
POST /v1/chat/completions
The header needs to set the Authorization header:
Authorization: Bearer [refresh_token]
Request data:
{
// Fill in the model name as you like.
"model": "step",
"messages": [
{
"role": "user",
"content": [
{
"type": "file",
"file_url": {
"url": "https://mj101-1317487292.cos.ap-shanghai.myqcloud.com/ai/test.pdf"
}
},
{
"type": "text",
"text": "What does the document say?"
}
]
}
]
}Response data:
{
"id": "85774360661086208",
"model": "step",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "This is a doc about the magic of love. balabala..."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 2
},
"created": 1711903489
}Provide an accessible image URL or BASE64_URL to parse.
This format is compatible with the gpt-4-vision-preview API format. You can also use this format to transmit documents for parsing.
POST /v1/chat/completions
The header needs to set the Authorization header:
Authorization: Bearer [refresh_token]
Request data:
{
// Fill in the model name as you like.
"model": "step",
"messages": [
{
"role": "user",
"content": [
{
"type": "image_url",
"image_url": {
"url": "https://k.sinaimg.cn/n/sinakd20111/106/w1024h682/20240327/babd-2ce15fdcfbd6ddbdc5ab588c29b3d3d9.jpg/w700d1q75cms.jpg"
}
},
{
"type": "text",
"text": "What does the image describe?"
}
]
}
]
}Response data:
{
"id": "85773574417829888",
"model": "step",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "This image shows the site of an event that appears to be the launch of some new product or technology."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 2
},
"created": 1711903302
}Check whether refresh_token is alive. If live is not true, otherwise it is false. Please do not call this interface frequently (less than 10 minutes).
POST /token/check
Request data:
{
"token": "267bcc81a01c2032a11a3fc6ec3e372c380eb9d1@eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Response data:
{
"live": true
}If you are using Nginx reverse proxy step-free-api, please add the following configuration items to optimize the output effect of the stream and optimize the experience.
# Turn off proxy buffering. When set to off, Nginx will immediately send client requests to the backend server and immediately send responses received from the backend server back to the client.
proxy_buffering off;
# Enable chunked transfer encoding. Chunked transfer encoding allows servers to send data in chunks for dynamically generated content without knowing the size of the content in advance.
chunked_transfer_encoding on;
# Turn on TCP_NOPUSH, which tells Nginx to send as much data as possible before sending the packet to the client. This is usually used in conjunction with sendfile to improve network efficiency.
tcp_nopush on;
# Turn on TCP_NODELAY, which tells Nginx not to delay sending data and to send small data packets immediately. In some cases, this can reduce network latency.
tcp_nodelay on;
#Set the timeout to keep the connection, here it is set to 120 seconds. If there is no further communication between client and server during this time, the connection will be closed.
keepalive_timeout 120;Since the inference side is not in step-free-api, the token cannot be counted and will be returned as a fixed number!!!!!