Skip to content
This repository has been archived by the owner on Aug 9, 2024. It is now read-only.

Commit

Permalink
Merge pull request #166 from imaarov/issue/165-document-the-post-v1-t…
Browse files Browse the repository at this point in the history
…utor-fen-endpoint

Implemented Tutor Fen Document
  • Loading branch information
programarivm authored May 31, 2024
2 parents 9000f84 + f2d36e2 commit 0791cac
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/post-tutor-fen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# POST /v1/tutor/fen

Describe positions of a chess game

## Parameters

| Name | Description | Required |
| ---- | ----------- | -------- |
| fen | A FEN string. | Yes |

```bash
curl --request POST \
--url https://api.chesslablab.org/v1/tutor/fen \
--data '{"fen":"r1bq1rk1/pppnn1bp/3p2p1/3Ppp2/2P1P3/2N2P2/PP2B1PP/R1BQNRK1 w - f6"}'
```

```text
"White is totally controlling the center. The white pieces are significantly better connected. White has a moderate space advantage. The black player is pressuring a little bit more squares than its opponent. White has a slight advanced pawn advantage. d5 is an advanced pawn. e6 and d4 are outpost squares. Overall, 4 heuristic evaluation features are favoring White while 1 is favoring Black."
```

0 comments on commit 0791cac

Please sign in to comment.